Here is what I think works right now, please correct any mistakes. Attributes:
project ------- * defaults to the name attribute of the enclosing project * is used as the name in case (2) way below module ------ * defaults to the name attribute of the enclosing module * if it points to a different module, this module must exist * moves the javadoc element to the module it points to title ----- * no default * sets title attribute for nested description element if that one is cloned from the enclosing project * no effect as the title attribute of nested description elements doesn't have any effect nested ------ * directory relative to srcdir of the containing module * points to the documentation that should be published * either this or parent must be set, nested takes precedence over parent (not really true, if both are omitted, parent="" will be assumed) parent ------ * directory relative to base directory of the workspace * points to the documentation that should be published * either this or nested must be set, nested takes precedence over parent (not really true, if both are omitted, parent="" will be assumed) Child elements: description ----------- * if omitted, the description element of the enclosing project will be used. If the javadoc has a title attribute, this will override the title of the projects description. * multiple elements can be used, each element creates a link on the javadoc listing * Nested text is used as the text for the link in javadoc listing Attributes: title ----- * no effect dir --- * defaults to "" * directory relative to nested/parent of enclosing javadoc that point to the documentation that should be published. Now, how does the javadoc listing page look like ================================================ (1) If this javadoc element is the only one in the enclosing module and no other javadoc point to this project via its project attribute (actually this is on the module level, hmm). <a>name of module</a> - text nested into description (2) multiple javadoc elements in the same module, some of them may originate from a different module <b>name of module</b> <a>name<a> - text nested into description ... repeat for all javadoc elements ... (3) multiple descriptions inside a single javadoc <b>name of module</b> <a>text nested into description</a> ... repeat for all description elements ... Some questions ============== * shouldn't (1) use the project attribute of the javadoc tag as well instead of the name of the module? * can we drop the title attribute or alternatively make that one override the content of the description element if we use the default? * from my limited understanding of XSLT, case (3) will only work if project and module have the same name, otherwise (2) will be used. Correct? Stefan -- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
