New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

javadoc: improve content rendering of Java wrappers #14766

Open

alalek opened this issue Jun 8, 2019 · 6 comments

Labels

category: documentation category: java bindings feature vote

Member

alalek commented Jun 8, 2019 •

edited

Current Issues:

some formula blocks are broken
missing images (see .png in text)
missing "see also" links
paragraphs without line breaks
some lists formatting are broken

Possible variants are in comments below.

Example

Link (page will be auto-updated, see screenshot from 2019-06-08).

relates #14667

Vote: use emoji buttons for comments below (:+1: / :-1: )

Member Author

alalek commented Jun 8, 2019 •

edited

Option 1:

Lets keep the current approach (see #14667).
We can add more rules to translate from doxygen to Javadoc.

Member Author

alalek commented Jun 8, 2019 •

edited

Option 2:

Replace with cross-links on doxygen C++ documentation.

Issues:

overloads handling, renames via CV_WRAP_AS
Android Javadoc is not bundled with C++ documentation

Member Author

alalek commented Jun 8, 2019 •

edited

Option 3:

Copy description from doxygen generated pages of C++ documentation (as HTML content).

Issues:

overloads handling, renames via CV_WRAP_AS
Android? (no C++ generated documentation in Android builds)

Member Author

alalek commented Jun 8, 2019 •

edited

Write your suggestion or updates in comments below.

This comment has been minimized.

Sign in to view

This comment has been minimized.

Sign in to view

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment