HAL Drivers User Manual Eclipse Help

Posted on March 19, 2018 at 17:45

I wanted to ask if it would be possible for ST to make HAL drivers user manual available for eclipse help. As HAL user manual is written in doxygen format, this is easy to generate eclipse specific help files.

This is a part of Doxyfile configuration which is used to generate doxygen documents:

♯ If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be

♯ generated, together with the HTML files, they form an Eclipse help plugin. To

♯ install this plugin and make it available under the help contents menu in

♯ Eclipse, the contents of the directory containing the HTML and XML files needs

♯ to be copied into the plugins directory of eclipse. The name of the directory

♯ within the plugins directory should be the same as the ECLIPSE_DOC_ID value.

♯ After copying Eclipse needs to be restarted before the help appears.

These user manual files are only available under CHM format at the moment.

#hal #document #user-manual