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

Please convert markdown-style comments to JavaDoc #146

Open
lukehutch opened this issue Feb 4, 2016 · 2 comments
Open

Please convert markdown-style comments to JavaDoc #146

lukehutch opened this issue Feb 4, 2016 · 2 comments

Comments

@lukehutch
Copy link

There is lots of good documentation auto-extracted from the TensorFlow header files here:

https://github.com/bytedeco/javacpp-presets/blob/master/tensorflow/src/main/java/org/bytedeco/javacpp/tensorflow.java

However, the docs use line comments, not JavaDoc comments, so the documentation is not visible in popups in Eclipse etc.

In this case, the comments are in MarkDown format. It would be great if you could specify that (1) line comments extracted from header files should be converted to JavaDoc block comments; and (2) (optionally) that comments should be parsed as MarkDown, and converted into JavaDoc's own weird HTML variant. (e.g. prettyprint blocks in the TF docs should be wrapped in <code>, etc.)

Thanks!

@saudet
Copy link
Member

saudet commented Feb 6, 2016

JavaCPP already converts much of Doxygen, including Markdown, into what can be represented with Javadoc. The problem though is that a lot of the comments in Tensorflow are not in Doxygen format, even though they are supposed to be: tensorflow/tensorflow#14

So, it looks like we have to figure out how to parse those g3doc comments properly. It's not obvious to me how those differ from normal non-documentation comments. Help would be welcome!

@saudet
Copy link
Member

saudet commented May 19, 2016

Any updates on this? Would be nice to know what to do about that.

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

No branches or pull requests

2 participants