Skip to content

Fix javadoc generation#23672

Merged
mshabunin merged 1 commit intoopencv:4.xfrom
mshabunin:fix-javadoc17
May 24, 2023
Merged

Fix javadoc generation#23672
mshabunin merged 1 commit intoopencv:4.xfrom
mshabunin:fix-javadoc17

Conversation

@mshabunin
Copy link
Copy Markdown
Contributor

@mshabunin mshabunin commented May 24, 2023

I've met a javadoc generation error on Ubuntu 22:

  [javadoc] /build-docs/modules/java/jar/opencv/java/org/opencv/calib3d/Calib3d.java:11320: error: element not closed: ul
  [javadoc]      * <ul>
  [javadoc]        ^
  [javadoc] /build-docs/modules/java/jar/opencv/java/org/opencv/calib3d/Calib3d.java:11348: error: unexpected end tag: </li>
  [javadoc]      *   </li>
  [javadoc]          ^
  [javadoc] /build-docs/modules/java/jar/opencv/java/org/opencv/calib3d/Calib3d.java:11349: error: unexpected end tag: </ul>
  [javadoc]      * </ul>
  [javadoc]        ^

Reason: a list of items in the parameter description does not generate good html, </ul> and </li> elements are added after the following @param item. It looks as follows and my version of javadoc (17.0.6) fails:

@param first param
<ul>
<li>abc</li>
<li>def
@param second param
</li>
</ul>

asmorkalov
asmorkalov approved these changes May 24, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@asmorkalov asmorkalov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@asmorkalov asmorkalov added the category: documentation Documentation fix or update label May 24, 2023
@mshabunin mshabunin merged commit 537060d into opencv:4.x May 24, 2023
@mshabunin mshabunin deleted the fix-javadoc17 branch May 24, 2023 20:07
@asmorkalov asmorkalov mentioned this pull request May 31, 2023
Merged
thewoz pushed a commit to thewoz/opencv that referenced this pull request Jan 4, 2024
@mshabunin @thewoz
Merge pull request opencv#23672 from mshabunin:fix-javadoc17
37cb27b
thewoz pushed a commit to thewoz/opencv that referenced this pull request May 29, 2024
@mshabunin @thewoz
Merge pull request opencv#23672 from mshabunin:fix-javadoc17
340efe9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@asmorkalov asmorkalov asmorkalov approved these changes

Assignees

No one assigned

Labels

category: documentation Documentation fix or update

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mshabunin @asmorkalov