Changeset View
Changeset View
Standalone View
Standalone View
core/page.h
Show First 20 Lines • Show All 178 Lines • ▼ Show 20 Line(s) | 54 | public: | |||
---|---|---|---|---|---|
179 | * | 179 | * | ||
180 | * @param id An unique id for this search. | 180 | * @param id An unique id for this search. | ||
181 | * @param text The search text. | 181 | * @param text The search text. | ||
182 | * @param direction The direction of the search (@ref SearchDirection) | 182 | * @param direction The direction of the search (@ref SearchDirection) | ||
183 | * @param caseSensitivity If Qt::CaseSensitive, the search is case sensitive; otherwise | 183 | * @param caseSensitivity If Qt::CaseSensitive, the search is case sensitive; otherwise | ||
184 | * the search is case insensitive. | 184 | * the search is case insensitive. | ||
185 | * @param lastRect If 0 (default) the search starts at the beginning of the page, otherwise | 185 | * @param lastRect If 0 (default) the search starts at the beginning of the page, otherwise | ||
186 | * right/below the coordinates of the given rect. | 186 | * right/below the coordinates of the given rect. | ||
187 | * @param wholeWords If true, match whole words only. | ||||
187 | */ | 188 | */ | ||
188 | RegularAreaRect* findText( int id, const QString & text, SearchDirection direction, | 189 | RegularAreaRect* findText( int id, const QString & text, SearchDirection direction, | ||
190 | Qt::CaseSensitivity caseSensitivity, const RegularAreaRect * lastRect, | ||||
191 | const bool wholeWords) const; | ||||
192 | // To be merged with wholeWords = false, not forget to initialize lastRect with nullptr | ||||
aacid: Both functions need to have proper documentation. And the new one needs a since marker (same… | |||||
Done the TODO part. joaonetto: Done the TODO part.
Is this documentation all right?
If not, can you explain what should I be… | |||||
193 | RegularAreaRect* findText( int id, const QString & text, SearchDirection direction, | ||||
189 | Qt::CaseSensitivity caseSensitivity, const RegularAreaRect * lastRect=nullptr) const; | 194 | Qt::CaseSensitivity caseSensitivity, const RegularAreaRect * lastRect=nullptr ) const; | ||
190 | 195 | | |||
191 | /** | 196 | /** | ||
192 | * Returns the page text (or part of it). | 197 | * Returns the page text (or part of it). | ||
193 | * @see TextPage::text() | 198 | * @see TextPage::text() | ||
194 | */ | 199 | */ | ||
195 | QString text( const RegularAreaRect * rect = nullptr ) const; | 200 | QString text( const RegularAreaRect * rect = nullptr ) const; | ||
196 | 201 | | |||
197 | /** | 202 | /** | ||
▲ Show 20 Lines • Show All 226 Lines • Show Last 20 Lines |
Both functions need to have proper documentation. And the new one needs a since marker (same for all the other "public" functions) in core/*.h you added/changed
And the "to be merged" should be marked with a TODO so maybe we see it when we decided to break BC