Hi, I have some questions about auto-generating documentation for a custom module. I have a Matlab function to create my custom module which is in this format:
function sys = matlab_function_name_module(NAME)
% Some helpful comments and documentation
sys = awe_subsystem('ModuleNameString', 'Description of my module');
sys.name = NAME;
% More code to do useful things
The name of the file containing this function matches the function name. In a different script, I use these commands for generating the documentation:
sys = matlab_function_name_module('name');
This works fine, and generates some HTML documentation. But I have a few issues/questions:
- When I call from the Matlab command line `awe_help matlab_function_name_module`, I get an error saying "Error using awe_help, No help documentation exists for module". According to Section 6.1 "awe_help" of the Custom Module Developers' guide (page 108 in my version), I thought that calling this command should generate documentation on the fly if it doesn't already exist in the correct location. What is going wrong here, that an error is being thrown, instead of the correct documentation being generated? (I also tried using the command `awe_help ModuleNameString`, which to my surprise didn't throw an error, but also didn't load up any HTML documentation in my browser)
- When I drag this custom module into an AWE designer window from the sidebar and right-click on the module, the option for "Help" is greyed out and inaccessible. What do I have to do to be able to access "Help" by right-clicking on the module in Designer? (I notice other 3rd party modules not developed by us do not seem to have the "Help" option greyed out)
- It says in Section 6.3 "Selecting the Documentation Format" of the module developers guide that using the command `AWE_INFO.docControl.format='doc';` should generate documentation in Word format, but for me, after calling `global AWE_INFO`; AWE_INFO.docControl.format='doc'; awe_generate_doc(...);`, the documentation was still in HTML format. How do I get documentation in Word format?
- In the generated HTML documentation, under "Type Definition", I only have the text "-- Not Shown --". What do I need to do to get a proper type definition shown here?