Details
- Reviewers
bruns - Group Reviewers
Baloo - Commits
- R293:60d6fc82ae5a: add documentation to result class
Diff Detail
- Repository
- R293 Baloo
- Branch
- result_documentation
- Lint
No Linters Available - Unit
No Unit Test Coverage - Build Status
Buildable 5656 Build 5674: arc lint + arc unit
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.
I think methods reimplemented from and documented in KFileMetaData::ExtractionResult should not be documented here.
src/file/extractor/result.h | ||
---|---|---|
35 | Remove the last part of the sentence - ... is saved to.. Everything else is an implementation detail. | |
37 | `The results can be retrieved as a Baloo::Document using \c document() and | |
48 | This is no overload, but an override/reimplementation. | |
51 | I think a \sa KFileMetaData::Property is sufficient here. Also, its not a property name, that would be something like a QString. |
src/file/extractor/result.h | ||
---|---|---|
68 | The use case is missing here. | |
72 | Thats not correct, see implementation of Result::add(...) QString p = QString::number(propnum) But as m_map/map() is never used outside Result (only in Result::finish), it is best to remove the getter completely. D17312 |
src/file/extractor/result.h | ||
---|---|---|
98 | Only properties |
src/file/extractor/result.h | ||
---|---|---|
58 | Qt uses "Reimplemented from KFileMetaData::ExtractionResult::addtype()`, see e.g. http://doc.qt.io/qt-5/qfile.html#fileName Overriden has a typo, "Overridden" But I think you should remove the (docstring) comment, it should automatically pick up the description from the interface class. | |
90 | Nitpick - missing full stop, also below. |
src/file/extractor/result.h | ||
---|---|---|
90 | The TermGenerator's do not contain any data themselves, but
|
src/file/extractor/result.h | ||
---|---|---|
90 | Would be nice if you could add that information to the TermGenerator :) |