documentation

Although related to this question about LaTeX being used outside mathematics and academia , I'm specifically wondering if anyone uses or is familiar with anyone that uses LaTeX for generating any type of documentation relating to software. If so, could you say whether or not you like LaTeX and the purposes for which you use it? Thanks. I mostly write academic papers with LaTeX. However, my research has to do with software documentation, so I actually deal with some of these concerns. The best thing about LaTeX is that you are concerned with content and structure, not just visual layout. This

Sphinx is a new documentation tool for Python. It looks very nice. What I'm wondering is: How suitable this is for documenting a C++ project? Are there any tools for converting existing documentation (e.g. doxygen) to Sphinx format? Are there online/downloadable examples of C++ projects that use Sphinx? Any tips from anyone who has used Sphinx? daspostloch As mentioned here and here , Sphinx native C++ support is related to highlighting/formatting/referencing, not in-code documentation extraction breathe has developed out of the discussion that chrisdew referenced [Edit inserted below]: I

Is there some kind of WebGL manual that lists all the functions etc. ? I tried Google but found nothing. These two resources helped me a lot Mozilla Devloper Pages Great blog with lessons I followed! Jinhyung Park WebGL Cheat Sheet http://web.archive.org/web/20120314072005/http://www.nihilogic.dk/labs/webgl_cheat_sheet/WebGL_Cheat_Sheet.pdf WebGL Quick Reference Card http://www.khronos.org/files/webgl/webgl-reference-card-1_0.pdf There is also the official manual — the WebGL specification: https://www.khronos.org/registry/webgl/specs/1.0/ You should use Giles Thomas' guide: http://www

I have to document my API's. I have to use any one of them Slate Or Swagger . I want to know which one have more options, pros and cons, which one is better. Swagger and Slate serve two different purposes. Swagger is an attempt at a standardized way of describing a RESTful API (similar, for example, to ApiBlueprint ) Swagger is a JSON based API definition format, which allows for the description of REST APIs. ~ API Design Tooling From Swagger Slate, on the other hand is a pretty theme for writing nice API docs. The two are not mutually exclusive Ideally, one should generate your slate

Sphinx is a Python library to generate nice documentation from a set of ReST formatted text files. Not the tool used for full-text searching I'm also fully aware of doxygen / phpdoc tools. I'm trying to figure out if there is a way of using Sphinx to document php projects? or even any other non-python languages? http://sphinx.pocoo.org/ Sphinx and ReST can be used as generic documentation tools, in my experience. There's nothing about Sphinx which obligates you to only use it for Python-based projects. For example, in my work, I've used it to build a user guide and an XML-RPC API reference. In

So I'm trying to document the format of the json returned by an api I am writing against and I'd like to know if there is any popular format for the documentation of json structure. Note I'm not trying to to test or validate anything, I'm just using this for documentation. Also some ways to add comments to non-constants(items always returned w/ the same value) would be nice. This the not totally thought out scheme I'm currently using: Plain names refer to identifiers or types. Some types have type-comment Strings that appear to be constant(always returned for that type of request) strings are

I am looking for a tool which could help me generate RESTful API documentation. My server is written in Java and uses Spring MVC framework. I do not have VIEWS in my server. It's a 100% RESTful service and all it does is consumes JSON and spits out JSON. I was wondering if Swagger is compatible with Spring annotations? There currently is not a Spring MVC swagger module available (from Wordnik at least) but in general, enabling swagger on a JVM-based REST service is pretty simple. Swagger server support is divided into two parts--the core server and the integration with the REST service. See

This question already has an answer here: How Do I Document Packages in Java? 3 answers I am using CheckStyle , FindBugs , and PMD to validate my Java code. I have fixed almost all the bugs caught by these tools. I am not able to understand how to write "package comment" which is a bug caught by checkstyle. I have gone through the documentation of CheckStyle, but I don't understand it. Could someone help me in writing a package level comment in Java? Michael Borgwardt Package-level javadoc comments are placed in a file named package-info.java inside the package directory. It contains the

I'm taking over a development of a commercial web site. This site was developed over two years by another programmer. It's mostly a one-man job (maintain and expand the site). I'll have a 2-3 days transition period when the other programmer will show me the system. But from what I know, there is little documentation. Everything is in the code (which is kind of documented). Here is what I'm planning to ask so far: Explanation on the most complex elements of the system Description of the overall architecture Description of the support tools (IDE setup, unit tests, deployment mechanism) Any book,

What's the best way to markup methods/URLs for a RESTful webservice using ReST/Sphinx? Is there a default domain that's suitable for marking up URLs with their possible parameters, HTTP methods, headers and body content? Something along the lines of: .. rest:method:: GET /api/foo :param bar: A valid bar :extension: json or xml Retrieve foos for the given parameters. E.g.:: GET /api/foo.json?bar=baz Does something like this already exist or is one of the default extensions usable, or will I have to write one myself? The Sphinx Contrib project also seems to have an HTTP Domain package for