Hello everyone! What tools or libraries are you using to auto-magically export your API documentation, and why did you choose it?

I’ve been searching around, however I’vw noticed that most “top 10” lists try to sell you on whatever they’ve been building in house. So… rather than listen to sales, I’d rather get the opinions from the people that matter: the developers.

  • bluGill
    link
    fedilink
    211 months ago

    Doxygen. Because we started using it once in a while years ago without looking for alternatives, and it still works. Life is too short to spend time asking if a better tool exists for every possible thing.

    The hard part isn’t exporting documentation, it is writing useful how to use it. Any hints here would be useful. It is easy to parse C++ compared to the effort of writing useful prose about out APIs. (C++ is one of the hardest languages to parse, but compared to writing)

  • sanimalp
    link
    fedilink
    211 months ago

    Graphql. Define the schema, then use a tool to read it. Then federate.

  • mac
    link
    fedilink
    211 months ago

    Readme.io is what we use. The free plan is pretty generous, we’ve been on it for years and not had any need to upgrade for additional features.