GeneralEnvironment or Command for documenting an API

LaTeX specific issues not fitting into one of the other forums of this category.
Post Reply
jdaily
Posts: 1
Joined: Sat Dec 17, 2011 2:02 am

Environment or Command for documenting an API

Post by jdaily »

Is there an environment, a set of commands, etc for documenting an API? We're looking to document our library which has Fortran, C, C++, and Python interfaces. Those interfaces share a lot of common documentation besides the function signatures and we'd like to have all function signatures together in one place. Is there a package available for nicely documenting function signatures and associated documentation?

Recommended reading 2024:

LaTeXguide.org • LaTeX-Cookbook.net • TikZ.org

NEW: TikZ book now 40% off at Amazon.com for a short time.

localghost
Site Moderator
Posts: 9202
Joined: Fri Feb 02, 2007 12:06 pm

Re: Environment or Command for documenting an API

Post by localghost »

How would such a documentation look like? Can you give at least a visual example?


Best regards and welcome to the board
Thorsten
Post Reply