search

jQAssistant / Idea-Hub

Hub to propose and discuss new ideas, features, as well as general issues
0 stars 0 forks source link

Use Asciidoctor to write the API documentation for jQAssistant. #10

Closed obfischer closed 2 months ago

obfischer commented 8 years ago

We schould be able to write our API documenation using Asciidoctor syntax and convert the existing API documentation also to Asciidoctor.

This is a precondition for jQAssistant/jQA-Idea-And-Support-Hub#4.

obfischer commented 8 years ago

There are some generated classes with traditional Javadoc in the package com.buschmais.jqassistant.core.analysis.rules.schema.v1. The documentation of these classes wan't be generated properly.

obfischer commented 8 years ago

The classes generated from our XSD documents contain always the traditional JavaDoc comments. The only solution to get rid of these comments is to write a plugin for X2J. This plugin would remove the comments from the generated classes. The disadvantage of this solution is that we have to setup for this plugin a new project and repository. As this plugin must be declared as dependency of org.jvnet.jaxb2.maven2:maven-jaxb2-plugin it can't be build as module of jQAsisstant itself.

obfischer commented 8 years ago

Referred to wrong issue in commit message. My fault. :-(