Skip to content

Conversation

asashour
Copy link
Contributor

@asashour asashour commented May 31, 2019

This change is to remove redundant return doc, for a method with void type.

It prevents the success of opencv/opencv#14667, and the corresponding error is here

Please suggest if other text should be written instead.

opencv=javadoc
**WIP**
force_builders=Docs

@alalek
Copy link
Member

alalek commented May 31, 2019

Internal code comments must not be a part of public API documentation.

In other words - fixing .cpp can't help with documentation.
You should fix public .hpp file instead.

@alalek alalek merged commit cd7276f into opencv:3.4 Jun 6, 2019
@alalek alalek mentioned this pull request Jun 7, 2019
Saafke pushed a commit to Saafke/opencv_contrib that referenced this pull request Jun 24, 2019
* doc: fix return parameter for void method

* docs: add missing parameter description
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants