Incorrectly documented parameters identified by rst_parser.py (Bug #1205)
| Status: | Open | Start date: | |
|---|---|---|---|
| Priority: | Normal | Due date: | |
| Assignee: |  Oleg Sklyarov |
% Done: | 0% |
| Category: | documentation | ||
| Target version: | Next Hackathon | ||
| Affected version: | branch '2.4' | Operating System: | |
| Difficulty: | HW Platform: | ||
| Pull request: |
Description
See the list attached.
Command to reproduce the list:
python2.6 -B modules/java/rst_parser.py all | grep "warning.*documented" > params.log
Associated revisions
#1205 fixed ~100 of ~700 parameters
#1205 fixed more bugs/typos in parameters
Fixed several false-positive warnings in rst_parser.py. (Now it detects 553 undocumented parameters for #1205.)
Some fixes for incorrectly documented parameters identified by rst_parser.py (Bug #1205)
Merge pull request #1205 from asmorkalov:winrt_api_cert_fix
History
Updated by Alexander Shishkov almost 13 years ago
- Subject changed from Incorrectly documented parametets idetrified by rst_parser.py to Incorrectly documented parameters identified by rst_parser.py
Updated by Kirill Kornyakov almost 13 years ago
- Target version set to 2.4.0
Updated by Alexander Shishkov almost 13 years ago
- Target version deleted (
2.4.0)
Updated by Alexander Shishkov almost 13 years ago
- Priority changed from High to Low
Updated by Alexander Shishkov almost 13 years ago
- Assignee deleted (
Vadim Pisarevsky)
Updated by Alexander Shishkov almost 13 years ago
- Target version deleted ()
Updated by Kirill Kornyakov over 12 years ago
Vsevolod, could you please inform about the current status? How many parameters are still incorrectly documented?
- Priority changed from Low to Normal
- Assignee set to Vsevolod Glumov
- Target version set to 2.4.3
Updated by Vadim Pisarevsky over 12 years ago
ok, at least some of the problems could be fixed during hackathon
- Target version deleted (
2.4.3) - Assignee deleted (
Vsevolod Glumov)
Updated by Vsevolod Glumov over 12 years ago
- Assignee set to Vsevolod Glumov
Updated by Kirill Kornyakov over 12 years ago
Vsevolod, we have discussed with Vadim what to do with differences in C and C++ argument's naming.
- In cases where we have simple difference, like lineType or line_type, please use C++ name for the C function. So, you can replace line_type with lineType and all similar occurrences.
- For a bit more complicated issues please create a txt-file highlighting the difference. We'll then decide if we should update the signatures, or just ignore these differences.
Updated by Kirill Kornyakov over 12 years ago
- Target version set to Next Hackathon
Updated by Kirill Kornyakov about 12 years ago
Oleg, since you're going to work on this regarding our needs, could you please update this ticket?
- Assignee changed from Vsevolod Glumov to Oleg Sklyarov
- Affected version set to branch '2.4'
Updated by Alexander Smorkalov over 11 years ago
List of documentation warnings updated.
- File params.log added
Updated by Leonid Beynenson over 11 years ago
Made pull request
https://github.com/Itseez/opencv/pull/1009
which allows to skip some warnings of the rst_parser.
Particularly, this pull request allows to skip the warning W007: parameter "..." is undocumented
Sometimes the documentation for such a parameter is not required (as an example, if there is a documented parameter lineType, no need to document the parameter line_type which is used in API 1.x variant of the function).
In this case we can add the commented line
.. :param line_type: (documentation isn't required)
and the warning won't be reported.
The line should start from ".. param:" and should end by "(documentation isn't required)"
Updated by Maksim Shabunin over 9 years ago
Issue has been transferred to GitHub: https://github.com/Itseez/opencv/issues/4285