General

jdaily · Post by **jdaily** » Sat Dec 17, 2011 2:08 am

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?

Learn LaTeX easily with newest books:

The LaTeX Beginner's Guide: 2nd edition and perfect for students writing a thesis

The LaTeX Cookbook: 2nd edition full of practical examples for mathematics, physics, chemistry, and more

LaTeX Graphics with TikZ: the first book about TikZ for perfect drawings in your LaTeX thesis

Post by **localghost** » Sat Dec 17, 2011 3:34 pm

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

Best regards and welcome to the board
Thorsten

LaTeX.org

General ⇒ Environment or Command for documenting an API

Environment or Command for documenting an API

Re: Environment or Command for documenting an API