search

NetworkingDevs / NS3-GUI-HELPER

This is GUI Helper for Basic NS3 Topologies.
https://networkingdevs.github.io/NS3-GUI-HELPER/
MIT License
1 stars 3 forks source link

Proposing `Doxygen Docs` for NS3-GUI-HELPER #15

Open 20CE034 opened 8 months ago

20CE034 commented 8 months ago

Example Docs of How-much-of-NEWS-are-you it requires basic installation steps, refer screenshot below image

official site - https://www.doxygen.nl/ , since its an automated code documentation, suits best for open source projects. Issue Tags - enhancement

HenilMistry commented 8 months ago

Thank you for showing off with this tool! Hopefully it will add great benefit to this project!

HenilMistry commented 8 months ago

Yeah, I totally agree with you. Other than doxygen, what are your thoughts on using

  1. Javadoc Tool
  2. NaturalDocs
  3. Sphinx
  4. DocFx
  5. ROBODoc
  6. Or some markdown based tools
20CE034 commented 8 months ago

ns3's doxygen documentation adoption is good since they are also using it - https://www.nsnam.org/doxygen/ making this software follow a standardized docs.

HenilMistry commented 8 months ago

Sure then, we'll match with the NS3.