to all plugin-developers: I would like to know what the best practice is in documenting the properties of a plugin (on sitedoc)?
plugin:generate-docs produces a skeleton for the sitedoc, but what is the best way to fill it with content? As I understood, there are two ways with different consequences: 1. edit the generated properties.xml file by hand and add description for the properties => this prevents you from using generate-docs again after changes to your plugin.properties file => you have to add new properties by hand and update changes (like default values) possibly in two places (or the docs will be inconsistent with the actual default property) 2. create a properties.jelly file in plugin-resources/templates => this seems to be a bit unintuitive to me Are there any other ways? Pulling the description and required tag somehow from the plugin.properties file to have it in one file? What is the best practice so far for the maven plugins? The website suggests the 1. alternative, are the consequences I mentioned correct? Thanks for any input, Oliver P.S. I think it's an important point because you want to avoid additional effort for plugin developers to keep their docs complete and up-to-date (which possibly results in inconsistent documentation which again possibly results in frustrated users that can't find the properties they are looking for). --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
