phpdocumentationdocumentation-generation

Generate a DOC for a REST API

I have generated my REST API, and now I have to write a documentation for the API.

As the API is mainly generated by a third-party plugin it's not possible to generate the DOC automatically.

So what the best tool (to save time) to manually write a DOC?

PS: I do have GitHub account, I wonder if the user pages can fit this need.

Solution

  • You can spent sometime to put DocBlock into all function/class you have built

    A tool like PHPDOC is available for you to compile DocBlock into documentation and regenerate whatever you need (into your desired format).

    Not to mention, is stored as static HTML