D17301: add documentation to result class

This revision was automatically updated to reflect the committed changes. astippich marked an inline comment as done. Closed by commit R293:60d6fc82ae5a: add documentation to result class (authored by astippich). REPOSITORY R293 Baloo CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D17

D17301: add documentation to result class

bruns accepted this revision. This revision is now accepted and ready to land. REPOSITORY R293 Baloo BRANCH result_documentation REVISION DETAIL https://phabricator.kde.org/D17301 To: astippich, #baloo, bruns Cc: yurchor, kde-frameworks-devel, ashaposhnikov, michaelh, astippich, spoorun,

D17301: add documentation to result class

astippich marked 2 inline comments as done. astippich added inline comments. INLINE COMMENTS > bruns wrote in result.h:79 > The TermGenerator's do not contain any data themselves, but > > - keep/update the position state when adding data > - add the data to the referenced Baloo::Document when su

D17301: add documentation to result class

astippich updated this revision to Diff 46987. astippich added a comment. - rephase description of TermGenerator REPOSITORY R293 Baloo CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D17301?vs=46864&id=46987 BRANCH result_documentation REVISION DETAIL https://phabricator.kde.o

D17301: add documentation to result class

bruns added inline comments. INLINE COMMENTS > result.h:79 > +/** > + * Contains the collection of words of the metadata. > + */ The TermGenerator's do not contain any data themselves, but - keep/update the position state when adding data - add the data to the referenced Baloo::Docu

D17301: add documentation to result class

bruns added a comment. In D17301#371323 , @astippich wrote: > Thanks for your patience :) Thanks for bearing with my nagging ;-) REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kde.org/D17301 To: astippich, #baloo, bruns

D17301: add documentation to result class

astippich added a comment. Thanks for your patience :) REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kde.org/D17301 To: astippich, #baloo, bruns Cc: yurchor, kde-frameworks-devel, ashaposhnikov, michaelh, astippich, spoorun, ngraham, bruns, abrahams

D17301: add documentation to result class

astippich updated this revision to Diff 46864. astippich added a comment. - remove docstring for reimplemented functions REPOSITORY R293 Baloo CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D17301?vs=46750&id=46864 BRANCH result_documentation REVISION DETAIL https://phabricat

D17301: add documentation to result class

bruns added inline comments. INLINE COMMENTS > result.h:58 > +/** > + * Overriden function from KFileMetaData::ExtractionResult. > + */ Qt uses "Reimplemented from KFileMetaData::ExtractionResult::addtype()`, see e.g. http://doc.qt.io/qt-5/qfile.html#fileName Overriden has a typo,

D17301: add documentation to result class

astippich marked 3 inline comments as done. REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kde.org/D17301 To: astippich, #baloo, bruns Cc: yurchor, kde-frameworks-devel, ashaposhnikov, michaelh, astippich, spoorun, ngraham, bruns, abrahams

D17301: add documentation to result class

astippich updated this revision to Diff 46750. astippich added a comment. - more adjustments REPOSITORY R293 Baloo CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D17301?vs=46706&id=46750 BRANCH result_documentation REVISION DETAIL https://phabricator.kde.org/D17301 AFFECTED

D17301: add documentation to result class

bruns requested changes to this revision. bruns added inline comments. This revision now requires changes to proceed. INLINE COMMENTS > result.h:105 > +/** > + * Contains all indexed data from the extractors > + */ Only properties REPOSITORY R293 Baloo REVISION DETAIL https://p

D17301: add documentation to result class

bruns added a dependency: D17312: Remove unused map() getter from Result. REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kde.org/D17301 To: astippich, #baloo, bruns Cc: yurchor, kde-frameworks-devel, ashaposhnikov, michaelh, astippich, spoorun, ngraham, bruns, abrahams

D17301: add documentation to result class

bruns added inline comments. INLINE COMMENTS > result.h:83 > + */ > void setDocument(const Baloo::Document& doc); > The use case is missing here. `Can be used to add extraction results to an existing Baloo::Document. Has to be called before passing the Result to KFileMetaData::Extrac

D17301: add documentation to result class

astippich marked 4 inline comments as done. REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kde.org/D17301 To: astippich, #baloo, bruns Cc: yurchor, kde-frameworks-devel, ashaposhnikov, michaelh, astippich, spoorun, ngraham, bruns, abrahams

D17301: add documentation to result class

astippich updated this revision to Diff 46706. astippich added a comment. - implement feedback REPOSITORY R293 Baloo CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D17301?vs=46687&id=46706 BRANCH result_documentation REVISION DETAIL https://phabricator.kde.org/D17301 AFFECTE

D17301: add documentation to result class

bruns added a comment. I think methods reimplemented from and documented in KFileMetaData::ExtractionResult should **not** be documented here. INLINE COMMENTS > result.h:38 > + * \brief The result class is where all the data extracted by > + * the KFileMetaData extractors is saved to a Baloo

D17301: add documentation to result class

astippich marked 4 inline comments as done. astippich added a comment. Thanks! REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kde.org/D17301 To: astippich, #baloo, bruns Cc: yurchor, kde-frameworks-devel, ashaposhnikov, michaelh, astippich, spoorun, ngraham, bruns, abrahams

D17301: add documentation to result class

astippich updated this revision to Diff 46687. astippich added a comment. - use param REPOSITORY R293 Baloo CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D17301?vs=46684&id=46687 BRANCH result_documentation REVISION DETAIL https://phabricator.kde.org/D17301 AFFECTED FILES

D17301: add documentation to result class

yurchor added inline comments. INLINE COMMENTS > result.h:56 > + * > + * \p property This specifies a property name. It should be one of the > + * properties from the list of properties from KFileMetaData. This should be `\param` https://www.stack.nl/~dimitri/doxygen/man

D17301: add documentation to result class

astippich added a comment. I had the impression that I have to read a lot of code just to know which variable does what, so I wrote some simple documentation. Please check if I got anything wrong. REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kde.org/D17301 To: astippich,

D17301: add documentation to result class

astippich added a dependency: D17300: add result to baloo namespace. REPOSITORY R293 Baloo REVISION DETAIL https://phabricator.kde.org/D17301 To: astippich, #baloo, bruns Cc: kde-frameworks-devel, ashaposhnikov, michaelh, astippich, spoorun, ngraham, bruns, abrahams

D17301: add documentation to result class

astippich created this revision. astippich added reviewers: Baloo, bruns. Herald added projects: Frameworks, Baloo. Herald added a subscriber: kde-frameworks-devel. astippich requested review of this revision. REPOSITORY R293 Baloo BRANCH result_documentation REVISION DETAIL https://phabri