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

Java 8 and asciidoclet #18

Closed
Vad1mo opened this issue May 5, 2014 · 5 comments
Closed

Java 8 and asciidoclet #18

Vad1mo opened this issue May 5, 2014 · 5 comments

Comments

@Vad1mo
Copy link

Vad1mo commented May 5, 2014

Hello,
Doclint in jdk 8 is very strict. Switching it of is also not a really good idea.

So the question is:

  1. Is java 8 supported?
  2. I have this entry in my javadoc. According to the asciidoctor docs I don't need to escape the special chracters but javadoc is complaining about the special characters. So who is right here?
/** 
* *Example:*
* [source,xml] 
* --
*                  <executions>
                    <execution>
                        <id>doIt</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
**/ --
@johncarl81
Copy link
Member

Sorry for the delay in getting back to you @Vad1mo. I haven't tested Asciidoclet in Java 8 extensively, but it does seem to run for me.

Doclint may complain as it is unaware of the doclet processing that occurs. What error are you getting specifically? What does the end result look like, does it format your xml properly?

@Vad1mo
Copy link
Author

Vad1mo commented May 19, 2014

This are mainly doclint issues
For example:
@see http://www.unece.org[UN/EDIFACT]
produces warnings. I guess it is not possible to run doclint after asciidoclet? It would be nice to have at least some doclint check.

@johncarl81
Copy link
Member

Getting back to this... finally

  1. Yes, Java 8 is supported.
  2. Javadoc complains about special characters for me as well. Not sure if there is a way to avoid the warning. From what I can tell doclint runs before Asciidoclet. My guess is that this style of doclet wasn't the intention for the doclet plugin approach.

@johncarl81
Copy link
Member

Closing for now. Feel free to reopen.

@gjoseph
Copy link

gjoseph commented Mar 18, 2015

In one of our project, when using the default doclet, we get a bunch of doclint failures, mostly for stuff that's indeed erroneous. When using asciidoclet, we get warnings instead. We don't get the warnings for, say, erroneous html, but we do get them for erroneous @see tags, for example. Is there any way we could control this behavior, i.e have it fail instead of just warn ? Is Javadoc's doclint somewhat reusable for other doclets (does that even make sense ?)
I tried -Xdoclint:all but I guess Asciidoclet would need to take into account for it to do anything.

ref: http://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#BEJEFABE

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

No branches or pull requests

3 participants