| Re: [ease-dev] Custom modules help generation |
Hi Serge, Module documentation files are always generated in the plugin that contains the module itself. For generation we use a custom doclet and run that on Javadoc. The doclet will parse javadocs from module classes, creates entries in the plugin.xml for the toc files and adds dependencies to eclipse.help Best try out manual generation first using following tutorial (at the very end) http://codeandme.blogspot.de/2014/10/writing-modules-for-ease.html I prefer to build documentation automatically as it then stays in-sync with your codebase and you do not need to check in the documentation at all. For maven integration have a look at the pom we use for the EASE build: http://git.eclipse.org/c/ease/org.eclipse.ease.core.git/tree/releng/org.eclipse.ease.releng/pom.xml Line 196ff contains the profile to build the documentation. HTH Christian From: ease-dev-bounces@xxxxxxxxxxx [mailto:ease-dev-bounces@xxxxxxxxxxx] On Behalf Of Serge Lamikhov-Center Hi, I have implemented a custom EASE module that works fine and functions of this module appear in the list of modules of "Modules Explorer". Now, I am going to provide a help system for the module's API. I have generated Javadoc, but, have a hard time to integrate it. Would you please explain how the help system for the modules is expected to work? For example, I see that Platform module's Javadoc is generated in org.eclipse.ease.modules.help, but, the actual HTML file that appears in Eclipse IDE Help is taken from /org.eclipse.ease.modules.platform/help/module_org.eclipse.ease.modules.platform.platform.html Was this file written manually? If it is generated, would you please describe the process? Thank you, Serge |
Attachment:
smime.p7s
Description: S/MIME cryptographic signature