-
Notifications
You must be signed in to change notification settings - Fork 40
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
Markdown not being processed in package-info.java files #44
Comments
Update to the above... SOME markdown is being processed. The <h1> header is NOT being processed. See the following example:
The header at the top is NOT being processed, but the definition below IS being processed. |
Hm … it worked fine for me. I couldn't imagine why this shouldn't work, anyway. What about the second h2? Is this one being processed? |
This also adds a specification demonstrating that the example from issue #44 works.
I've added a test that demonstrates that your example works – to a certain extent. The documentation is rendered fine in the full package documentation. However, the summary doesn't look nice. It seems that Javadoc just took the whole text until the first '.' as first sentence and removed all Tags from it. The result is the following summary:
Looking at the source code, the
In this case, this doesn't make much sense as a summary IMHO, but as far as I can see, this should be the correct behaviour. I'll look deeper into this. As a workaround, precede the full documentation with a simple summary paragraph. It looks like I'll have to fiddle with some Javadoc implementation internals here. |
For me it also does not work. Nothing interpretet. Even not your example. It keeps the raw text. |
I determined, that it works only if the package has a class! If it is empty, it does not process! |
@InfoSec812 This is actually documented behaviour: Option Invoking with If the locale is not set to 'en' (or using a locale specific sentence breaker is forced by The only workaround I see is: Use @andreashe That's a different thing. Probably, it also has nothing to do with this doclet. |
I have a Gradle project:
And inside of src/main/java/us/juggl/twentyfifteen/november/annotations/ I have a package-info.java file for the package level JavaDocs. Pegdown is not processing the markdown in that file, I just see raw text in the generated JavaDocs.
The text was updated successfully, but these errors were encountered: