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.

Inconsistencies between JavaDoc and AsciiDoc

See original GitHub issue

A substantial portion of the specification is duplicated (sometimes very inexactly) between the JavaDoc and AsciiDoc portions of the project. For example, the specification of converters uses very different language and structure between the JavaDoc of Converter and the converters.asciidoc document.

I think it would be worth considering one of the following:

Come up with some way to import common language into the AsciiDoc and JavaDoc from some common source
Remove the specification language from the JavaDoc and reference the AsciiDoc instead
Remove the specification language from the AsciiDoc and reference the JavaDoc instead
Introduce some tool that ensures that the AsciiDoc is in sync with the JavaDoc
Generate the AsciiDoc from the JavaDoc
Some other ideas?

Issue Analytics

State:
Created 4 years ago
Comments:5 (5 by maintainers)

Top GitHub Comments

1reaction

dmlloydcommented, Jan 27, 2020

This is not wholly solved; only the beginnings were done.

0reactions

Emily-Jiangcommented, Jan 29, 2020

Move this out of Config 1.4 release and target for the future release.

Top Results From Across the Web

How to use AsciiDoclet to generate asciidoc file from javadoc ...

I'm newbie with asciidoc. I want to generate HTML Documentation from commented javadoc (in asciidoc format) in java file.

Errors and Warnings | Asciidoctor Docs

All application messages (i.e., debug, info, warning, error, or fatal) emitted by Asciidoctor are written to the logger. By default, only warning, error, ......

Asciidoc throw warnings while building documentation - Red Hat

During the documentation build phase, the following errors are observed: Branch: 1.3. asciidoctor: WARNING: content-based-routing.adoc: line 76: invalid ...

How to contribute documentation - Quarkus

Quarkus docs use AsciiDoc, a lightweight markup language. ... Configuration documentation is generated from JavaDoc comments in Java source files.

AsciiDoc User Guide

Apart from asciidoc(1) and a Python interpreter, no other programs are required to convert AsciiDoc text files to DocBook or HTML.