this post was submitted on 20 Jul 2023
2 points (100.0% liked)

Programming

355 readers
1 users here now

This magazine is dedicated to discussions on programming languages, software development, and coding. Whether you are a beginner programmer or an experienced developer, this is the place for you. Here you can share your knowledge, ask questions, and engage in discussions on topics such as coding languages, software engineering, web development, and more. From the latest trends and frameworks to tips and tricks for debugging, this category covers a wide range of topics related to programming.

founded 1 year ago
 

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.

top 3 comments
sorted by: hot top controversial new old
[–] [email protected] 2 points 1 year 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)

[–] [email protected] 2 points 1 year ago

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

[–] [email protected] 2 points 1 year 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.