This commit is contained in:
Jean-Francois Dockes 2013-09-29 18:29:53 +02:00
parent e8f4949f4b
commit 334e16bee5
2 changed files with 11 additions and 6 deletions

View File

@ -358,11 +358,12 @@ class Db {
/** Get document for given udi /** Get document for given udi
* *
* Used by the 'history' feature, and to retrieve ancestor documents. * Used by the 'history' feature, and to retrieve ancestor documents.
* @param udi the unique document identifier * @param udi The unique document identifier.
* @param idxdoc used when there are several index as an opaque way to pass * @param idxdoc A document from the same database as an opaque way to pass
* the index id. Use a doc from the same index * the database id (e.g.: when looking for parent in a multi-database
* (e.g.: when looking for parent), * context).
* @param doc the output doc * @param[out] doc The output Recoll document.
* @return True for success.
*/ */
bool getDoc(const string &udi, const Doc& idxdoc, Doc &doc); bool getDoc(const string &udi, const Doc& idxdoc, Doc &doc);

View File

@ -125,6 +125,10 @@ class Db::Native {
/** Retrieve Xapian::docid, given unique document identifier, /** Retrieve Xapian::docid, given unique document identifier,
* using the posting list for the derived term. * using the posting list for the derived term.
* *
* @param udi the unique document identifier (opaque hashed path+ipath).
* @param idxi the database index, at query time, when using external
* databases.
* @param[out] xdoc the xapian document.
* @return 0 if not found * @return 0 if not found
*/ */
Xapian::docid getDoc(const string& udi, int idxi, Xapian::Document& xdoc); Xapian::docid getDoc(const string& udi, int idxi, Xapian::Document& xdoc);