Code Documentation from scratch
Try to follow this
Workflow mentioned in this page
Standard Documentation
- Try to draw relevant UML diagrams using puml tutorials,PUML Online Server, Building Blocks, hariyom.com drive
- Ensure Standardized Coding
- Try to cover as many titles and sub titles in http://www.outsource-online.net/blog/2022/07/02/developing-wordpress-plugin/
- create flow chart with http://flowchart.js.org/ git URL
- check doxygen tips at http://www.outsource-online.net/blog/2022/07/13/doxygen-basics/ and other doxygen tips
- check git steps in http://www.outsource-online.net/blog/2022/06/13/git-command-line-tutorials/
Steps to document
- make sure copy of latest code is updated to git . use quick File Explorer , make sure you know the local folder and local url, in my case it is
D:\projects\MyContributions\osolcontributions\quickfileexplorer\master
and local url. - Use pagenav class and its documentation as reference.another reference.
- Create list of main page and other pages as documentationPipeline.md
- Start with Main page
- proceed to classes
Use this regexp to get methods([^\}\r\n\/]+)function([^\(\r\n]+)\(
- add required markdown files
- Create documentation with doxygen. refer. starting doxygen
- create a new branch in git
- checkout documentation in a different branch &make public link, ie HTML pages in gitbub , HTML pages in bitbucket
|
|