API Documentation: Doxygen

Open ovflowd opened this issue 9 years ago • 6 comments

Planning to use Doxygen for API and Code Documentation.

Sep 16 '16 20:09 ovflowd

You're talking about the rest api? That isn't Yaml, that's either JSON or XML.

Sep 17 '16 10:09 TheDoct0r11

No, i'm talking about the API Documentation. Swagger uses YAML to generate the API Documentation. And Swagger is used for API Documentation, can also used for the REST Documentation. But mainly used for the Classes/Code Documentation xD

Sep 17 '16 14:09 ovflowd

I can't see anything on the Swagger website not related to REST. Also why would one want to write the docs within an extra file?

I'd rather suggest using a tool that uses the documentation that is within the code.

Doxygen is a very common tool.

Sep 17 '16 20:09 TheDoct0r11

@BurakDev can do that. With Doxygen

Sep 17 '16 20:09 ovflowd

@lai0n will do the Documentation with Doxygen.

Sep 20 '16 12:09 ovflowd

Remember.: need to do the HTML API Documentation and In-Code Documentation.

Sep 20 '16 12:09 ovflowd