Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [cbi-dev] Generating API documentation
Hi Christian,

As Jan said, for 1, platform URIs are resolved against your target platform. It includes all the artifacts that have been build during the build (sic). So in your case you should specify "platform:/plugin/another.plugin"

For 2, tocOptions is of no help. It only allows you to change the main label of the toc (see [1]). You should raise a bug against Tycho if you want to that. 

If your issue is just to attach the Javadoc to another toc file, I don't understand why you need to use anchor. You could generate the javadoc's toc file wherever you want (see [2]). Then in your master toc file you can reference it:

<topic label="Reference">
<link toc="help/developer/toc-javadoc.xml"></link>
</topic>

Cheers,
Mikael


Le 19 févr. 2015 à 18:48, Christian Pontesegger <christian.pontesegger@xxxxxx> a écrit :

Hi Mikael,

thanks for pointing me in the right direction. I have a basic build already running. But I ran into some questions, maybe you can help me out.

1) When using jars.extra.classpath, how are platform URIs resolved? Against the target platform? My maven cache? The current maven build?
I also tried to use relative locations, like “../another.plugin” but this did not work.

2) My API reference should be attached to an existing help anchor of another toc file. Regarding the documentation there is a tocOptions parameter available, but I could not find any detailed documentation on this. Is there a way to set a toc anchor using this property?

thanks
Christian

On 19.02.2015 09:27, Mikael Barbero wrote:
Hi Christian, 

There is the tycho-document-bundle-plugin (from org.eclipse.tycho.extras) that allows you to generate Javadoc for your bundles. 



_______________________________________________
cbi-dev mailing list
cbi-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/cbi-dev

Back to the top