[jboss-jira] [JBoss JIRA] (AS7-6072) Automate creating EAP 6.x public API Javadoc

[Ondrej Zizka (JIRA)]

    [ https://issues.jboss.org/browse/AS7-6072?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12823326#comment-12823326 ] 

Ondrej Zizka commented on AS7-6072:
-----------------------------------

David Lloyd:

Guys, when developing an API that is going to be shipped either as part 
of WildFly as a module or for end-user consumption, I want you to 
remember something:

Every public and protected member of that module *IS* API.  That means 
you can't ever change it without considering compatibility.  "Well I 
just made it public because this other module needs access to it" is not 
a valid excuse, nor is "Well I needed access from another package". 
Both are synonyms for "I screwed up my design at an early stage and now 
I want to break the rules to fix my mistake".

The only exception is if you're developing a component specifically and 
exclusively for use in the modular environment, and you put all non-API 
public members into a specific package or package set which is then 
excluded from export in the module.xml descriptor in the shipped 
environment.

If you do not fall into this exception then you are volunteering to 
personally maintain these non-public public classes for the next 10 
years come hell or high water, because people are surely going to use 
them, and I sure don't want to be the one to maintain them.

http://lists.jboss.org/pipermail/wildfly-dev/2013-October/000949.html
                
> Automate creating EAP 6.x public API Javadoc
> --------------------------------------------
>
>                 Key: AS7-6072
>                 URL: https://issues.jboss.org/browse/AS7-6072
>             Project: Application Server 7
>          Issue Type: Enhancement
>          Components: Build System, Documentation
>    Affects Versions: 7.1.3.Final (EAP)
>            Reporter: Ondrej Zizka
>            Assignee: Ondrej Zizka
>             Fix For: EAP 6.1.0.Alpha (7.2.0.Final)
>
>
> Docspace page: https://docspace.corp.redhat.com/docs/DOC-134981
> First attempt: https://jenkins.mw.lab.eng.bos.redhat.com/hudson/job/EAP6-javadoc/
> What's needed:
> * Blacklist of skipped .jar's (cause exceptions when generating)
> * XSLT to put <include>'s to pom.xml
> * XSLT to put <groups> to pom.xml
> See also https://docspace.corp.redhat.com/docs/DOC-105009 (bottom)

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira