Hi Mark,

I think the IDE shouldn't require HTTP access to a remote server to display 
content. In this case there would be no way in telling an IDE generically where 
for find the root of documentation for library X.

That's where the javadoc jars come in. At least for maven IDEs know that they 
simply have to load the jar {artifactId}-{version}-javadoc.jar if the class is 
in an artifact {artifactId}-{version}.{whatever}.

Currently the way I setup the JavaDoc for the flexjs compiler modules for being 
indexed by Google, they would produce:


for the current dev-branch. And in case of a release of 0.8.0 they would add:


So you could reference the explicit version of an API for documentation.

But in both cases there should be a html file to back the documentation for a 
given class and the path to that file should reflect the package structure.

I guess we both agree on that :-)


Von: Kessler CTR Mark J <mark.kessler....@usmc.mil>
Gesendet: Freitag, 14. Oktober 2016 12:34:10
An: dev@flex.apache.org
Betreff: RE: Re: [FalconJX] Generating ASDoc

> flex.apache.org/docs/flexjs/com.example.SomeComponent/
> flex.apache.org/docs/flexsdk/com.example.SomeComponent/

This would be great for be a great format for IDE's to be able to load 
documentation specific to the component you have selected.


Reply via email to