how to create harbour documentation?
Click on find in fileOpen source code in editor from find in file
Click on "Documentation Writer" Position cursor somewhere inside a function body,
Click on "Load from current function" icon on the top-toolbar of "Document Writer" widget,
Click on "Load from current function" icon on the top-toolbar of "Document Writer" widget,
Look at the contents, few fields will be auto filled with various info from current function,
Complete the other fields with relevent information,
Look at the function body in the editor, The NANFORUM compliant documentation will be inserted at the top of function's prototype.
Click on "Save written/updated documentation" icon, and provide the filename to save on disk,
Copy such generated .txt in /harbour/doc/en,
Open "Harbour Document Viewer" and you should be viewing newly written documentation there. Such generated file is ready to be uploaded to SVN, just send it to the list and group will decide if it needs something extra.
No comments:
Post a Comment