Code review comment for lp://qastaging/~kevin-wright-1/u1db-qt/synchronizer-merged-with-trunk-8-aug

Den 09/08/2013 11:20, skrev Christian Dywan:
> These are the doc errors I'm currently seeing with the latest changes. They need to be resolve before the branch can be merged:
>
> ./src/database.cpp:427: warning: Unknown command '\param'
> [Maybe you meant '\part'?]
> ./src/database.cpp:428: warning: Unknown command '\param'
> [Maybe you meant '\part'?]
> ./src/database.cpp:429: warning: Unknown command '\param'
> [Maybe you meant '\part'?]
> ./src/synchronizer.cpp:33: warning: Cannot find Synchronizer specified with \class in any header file
> ./src/synchronizer.cpp:156: warning: Cannot find Synchronizer::source specified with \property in any header file
> ./src/synchronizer.cpp:173: warning: Cannot find Synchronizer::targets specified with \property in any header file
> ./src/synchronizer.cpp:189: warning: Cannot find Synchronizer::synchronize specified with \property in any header file
> ./src/synchronizer.cpp:202: warning: Cannot find Synchronizer::errors specified with \property in any header file
> ./src/synchronizer.cpp:214: warning: Cannot find Synchronizer::errors specified with \property in any header file
> ./src/synchronizer.cpp:358: warning: Unknown command '\param'
> [Maybe you meant '\part'?]
> ./src/synchronizer.cpp:359: warning: Unknown command '\param'
> [Maybe you meant '\part'?]
> ./src/synchronizer.cpp:360: warning: Unknown command '\return'
> ./src/synchronizer.cpp:783: warning: Unknown command '\param'
> [Maybe you meant '\part'?]
> ./src/synchronizer.cpp:817: warning: Unknown command '\param'
> [Maybe you meant '\part'?]
> ./src/synchronizer.cpp:818: warning: Unknown command '\param'
> [Maybe you meant '\part'?]
> ./src/synchronizer.cpp:889: warning: Unknown command '\param'
> [Maybe you meant '\part'?]
> ./src/database.cpp:398: warning: Undocumented parameter doc_id in Database::getCurrentDocRevisionNumber()
> ./src/database.cpp:255: warning: No documentation for 'Database::getDocumentContents()'
> ./src/database.cpp:324: warning: Undocumented parameter doc_id in Database::getNextDocRevisionNumber()
> ./src/database.cpp:818: warning: No documentation for 'Database::getSyncLogInfo()'
> ./src/database.cpp:792: warning: No documentation for 'Database::listTransactionsSince()'
> ./src/database.cpp:619: warning: No documentation for 'Database::resetModel()'
> ./src/database.cpp:463: warning: No documentation for 'Database::updateDocRevisionNumber()'
> ./src/database.cpp:425: warning: Undocumented parameter transaction_id in Database::updateSyncLog()
> ./src/database.cpp:425: warning: Undocumented parameter generation in Database::updateSyncLog()
> ./src/database.cpp:425: warning: Undocumented parameter insert in Database::updateSyncLog()
> ./src/database.cpp:425: warning: Undocumented parameter uid in Database::updateSyncLog()
> ./src/query.cpp:161: warning: No documentation for 'Query::resetModel()'

Hopefully all fixed now. Could not find anything specific to resolve the
warnings about \property, but maybe this is resolved by the change to
fix the warning about \class.

Also \param is used elsewhere in source files, but perhaps was not used
properly in these instances. The references have been removed in the
latest commit, but perhaps this needs to be looked at again.

Kevin