API Documentation: Doxygen

[ovflowd]

Planning to use Doxygen for API and Code Documentation.

[TheDoct0r11]

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

[ovflowd]

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

[TheDoct0r11]

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.

[ovflowd]

@BurakDev can do that. With Doxygen

[ovflowd]

@lai0n will do the Documentation with Doxygen.

[ovflowd]

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