Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Gendoc/developerResources/PropertiesExample"
< Gendoc
(Created page with "== Presentation == The goal of the example is creating a tag named "Properties" which allows the registration of parameters using properties file == Contributing == === Open...") |
(→Code) |
||
Line 8: | Line 8: | ||
=== Code === | === Code === | ||
+ | |||
+ | ==== General Idea ==== | ||
+ | The good way to create a tag in gendoc is : | ||
+ | * create a handler (implements org.eclipse.gendoc.tags.ITagHandler) which analyze the tag | ||
+ | * create a service (extends org.eclipse.gendoc.services.AbstractService or implements org.eclipse.gendoc.services.IService) which will do business work | ||
+ | |||
+ | It is a common practice in gendoc to separate handlers and services | ||
+ | * Services can be overridden by developers so initial behavior can be changed | ||
+ | * It forces the developer to separate tha analysis of the tag and the business code | ||
+ | |||
+ | ==== Tag Handler ==== |
Revision as of 11:18, 26 July 2016
Presentation
The goal of the example is creating a tag named "Properties" which allows the registration of parameters using properties file
Contributing
Open a bug
first step is to create a new Bug categorized as an enhancement. In our example the created bug is : https://bugs.eclipse.org/bugs/show_bug.cgi?id=484129
Code
General Idea
The good way to create a tag in gendoc is :
- create a handler (implements org.eclipse.gendoc.tags.ITagHandler) which analyze the tag
- create a service (extends org.eclipse.gendoc.services.AbstractService or implements org.eclipse.gendoc.services.IService) which will do business work
It is a common practice in gendoc to separate handlers and services
- Services can be overridden by developers so initial behavior can be changed
- It forces the developer to separate tha analysis of the tag and the business code