question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Mixed traditional and Asciidoclet javadoc markup

See original GitHub issue

In Hibernate we are trying to migrate to using Asciidoclet to author Javadoc. However, as Hibernate is a huge project it is simply not feasible to convert all of the docs at once so we have been working on a phased approach change pieces at a time such that we end up with a mix of traditional and Asciidoclet javadoc markup within the same project.

But in practice this has led to problems rendering the javadocs. If we enable Asciidoclet it messes up some of the traditional Javadoc markup; e.g. it escapes and “passes through” all HTML tags (you literally end up with <p/>, <li>, etc in the rendered HTML output). And if we disable Asciidoclet, of course the standard doclet butchers the Asciidoctor markup.

Are we missing something here? Does a project have to use one or the other approach? If so, that is severely limiting for larger projects to move to Asciidoclet

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:47 (23 by maintainers)

github_iconTop GitHub Comments

1reaction
johncarl81commented, Nov 3, 2018

@mojavelinux, @msgilligan: it might be early as we haven’t gotten feedback, but would you review https://github.com/asciidoctor/asciidoclet/pull/91 and merge?

@sebersole, @gsmet: have you been able to use this feature, and, if so, does it meet your needs?

1reaction
johncarl81commented, Nov 3, 2018

Yes, that’s right @mojavelinux - it’s only useful when a class is excluded from being processed. For instance, we can either explicitly include classes for processing or exclude classes from processing, the resulting classes not processed can finally be added back into the set being processed by adding the @asciidoclet javadoc tag.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Getting Started - Asciidoctor Docs
Traditionally, Javadocs have mixed minor markup with HTML which, if you're writing for HTML Javadoc output, becomes unreadable and hard to write over...
Read more >
How to Write Doc Comments for the Javadoc Tool - Oracle
This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, ...
Read more >
Read Awesome Asciidoctor Notebook - Leanpub
Styling Columns and Cells in Tables. In a previous post we learned how to use Asciidoc markup in a table. The a character...
Read more >
asciidoclet 1.5.6 javadoc (org.asciidoctor)
https://javadoc.io/doc/org.asciidoctor/asciidoclet. Current version 1.5.6. https://javadoc.io/doc/org.asciidoctor/asciidoclet/1.5.6.
Read more >
John Ericksen
Traditionally, Javadocs have mixed minor markup with HTML which, if you're writing ... Asciidoclet incorporates an AsciiDoc renderer (Asciidoctor via the ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found