Setting up Doxygen Basic Tags mainpage tag The main page of a Doxygen documentation is specified using the \mainpage tag. This tag should be placed at the top of the file and should be followed by a brief description of the project. For example: /** * \mainpage My Project * * This is the main…
Category: Commenting
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…
References reference for tags Video Reference Good Table of Contents Reference Basic Documentation Files Generated Documentation Commonly Used Tags PHP Paginator project with Doxygen Documentation git Documentation Install Download You have to enter email and password, download link will be mailed Start Tripple slashes & a lesstan symbol ///< is single line comment for doxygen…
reference for tags Video Reference Source code Sample Code Install Node JS must be installed first. Download Node JS Global Install npm install -g jsdoc Local Install npm install –save-dev jsdoc Basic Intro Using VSCode Before a function. Just start with /** and press enter. Vscode will create a comment block skelton. eg: /** *…
For page like Index.php .
Mainly 3 types of commenting needs to be done Main page Module pages(Non class) eg: index.php Class pages Sample Project Comment Tips Regexp for searching functions //line containing 'function(' not starting with '}/' ^(?!(.*)\}\/)(.*)function\s+(.+)() Little more advanced version ^(?!(.*)\}\/)(.*)function\s+([^\(\r\n\=]+)\( OR if there is something like $function->, to avoid it ^(?!(.*)\}\/)(.*)function([^->=,'",\r,\n]+)\s+([^\r\n]+) For ES6 JS Classes Make…