Skip to content
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.

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

Use regex to translate Doxygen commands #278

Merged
merged 5 commits into from
Jan 9, 2019
Merged

Use regex to translate Doxygen commands #278

merged 5 commits into from
Jan 9, 2019

Conversation

HGuillemet
Copy link
Contributor

Small suggestion to use regex for parsing Doxygen commands.
Main use is to remove[in], [out] or [in,out] from @param, but may be a starting point for a more complex parsing.

@saudet
Copy link
Member

saudet commented Jan 8, 2019 via email

@HGuillemet
Copy link
Contributor Author

HGuillemet commented Jan 8, 2019

If you'd like to keep the direction parameter, we could translate \param[in] xxx yyy to something like @param xxx [in] yyy. Currently it becomes @param [in] xxx yyy which makes javadoc complains about non-existing [in] parameter.

@saudet
Copy link
Member

saudet commented Jan 8, 2019 via email

@HGuillemet
Copy link
Contributor Author

Here it is. This PR also translates \sa. Only \see were translated.
However obtaining a correct translation of all Doxygen grammar is quite impossible task. For instance some comments are lost because not at the right place in the .java. (/** */ blocks before a C++ namespace do not appear in javadoc because not moved before class, also Doxygen allows comments concerning the method after \param, but javadoc will treat this comment as part of the last @param).

@saudet
Copy link
Member

saudet commented Jan 8, 2019

Yeah, that's fine, as long as they appear in the source files themselves, we can refer to them. That's why we need to publish them somewhere, if not in src/gen/java/. :)

@saudet saudet merged commit 5a465e1 into bytedeco:jpms Jan 9, 2019
saudet pushed a commit that referenced this pull request Jan 11, 2019
saudet pushed a commit that referenced this pull request Jan 21, 2019
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.

None yet

2 participants