documentation

Where is the JetBrains IntelliJ openapi documentation?

I have searched Google and JetBrains website, but I cannot find docs for the com.intellij packages. Any IDEAs (:-))? ...

How do the Mogenerator parameters work, which can I send via Xcode?

The help for Mogenerator is very minimal. What do all the parameters do? ...

Best known method for creating/maintaining documentation of a C++ project?

The title says it all. But here a few points which concern me: How do you maintain documentation which will be released to customers? What about docs which are for internals use? How to document packages/classes/methods/APIs? How to ensure maintainability? e.g. check-in criteria, code review checklist item, automation. ...

Tools for generating HTML documentation

I've been writing documentation files in raw HTML for a small open source project in Java. Now I'm wondering if there are any good tools to automatically generate the HTML docs from some source files during the build process, with the main advantages being substitution of ${variables} and a consistent layout across all pages. An importa...

Documenting getters and setters

For simple getters/setters, like the one below, what's the best way to document it? public float getPrice() { return price; } I'm pretty strict about coding standards, so my IDE warns me about any undocumented public/protected methods. Option 1: /** * Get the price field. * * @return */ Option 2: /** * @return Price */...

jdoc/pydoc/rdoc for bash?

Is there a jdoc/pydoc/rdoc style inline documentation system for bash? I have a library of bash functions that could really use some nice inline docs that I can convert to HTML for easy reading. ...

Find the source file for class / method using ri or fastri for ruby

For example I do $fri group_by ---------------------------------------------------- Enumerable#group_by enum.group_by {| obj | block } => a_hash ------------------------------------------------------------------------ Returns a hash, which keys are evaluated result from the block, and values are arrays of elements in en...

Where can i find documentation references for previous releases of Tidy

This seems to be the current release: http://tidy.sourceforge.net/docs/quickref.html Can any one point me to the reference for Tidy Release '6 November 2007'? ...

What's the best way to include a PDF in my Sphinx documentation?

I have a PDF that has some in depth explanation for an example in the Sphinx documentation for a package I have. Is there a way to easily include the PDF in my project (and have it copy over when I build the docs)? I tried linking to it with :doc: but this did not copy it over. ...

Rails 3 is out and now there is no documentation online for 2.3.x

I thought I would start a wiki for links to old rails documentation since "Rails 3 is greatest thing since sliced bread" :). Rails 3 IS awesome, but I'm not moving to it yet. I can't find docs for 2.3.5 or 2.3.8 anywhere. The closest I can find to what I need is this: http://railsbrain.com/api/rails-2.3.2/doc/index.html +1 to anyone wh...

Best REST API documentation

What is the best REST API documentation that you've come across? What did you really like about it? HOWTOs? Videos? Code snippets? Browser based API explorer? For example, I quite like the Flikr API documentation - http://www.flickr.com/services/api/flickr.photos.search.html, especially the API explorer. The SOAPI-Explorer is also...

DotNetCart Better Documentation

I'm attempting to use the DotNetCart ecommerce module in a solution we are building. The problem i'm having is that i'm finding that the included .chm documentation is quite lacking. I've brought this up with their support dept and received no help there. My question is, is there a site or forum that is a good source of information on ho...

Insert relative link in reStructuredText

I am documenting a library that has a Python component and a JavaScript component. The overall user documentation, and the Python API documentation are in reStructuredText, processed with Sphinx. The JavaScript API is in jsdoc and is processed with jsdoc-toolkit. The principal output format will be HTML. I am new to reST, Sphinx and js...

Array index vs. "user documentation" terminology?

I have an "array" of bytes that is referenced in some high-level client/developer documentation (which does not contain any programming language or environment specific information). In this document, bytes are currently referred to as "byte 3" or "byte 17", etc. The development environment is C/C++ and the bytes are stored in an array i...

Internal product documentation

We have a system that has grown over a number of years (ASP.NET Web Forms, MySQL) and we're looking for guidance on what to document about it and how to document it so that we have a single place we can go to understand how the system should behave. This documentation would allow both developers and testers recognize what might be affec...

Any known discusson of why string identifiers are used to access resource data

I'm working a project to replace a Resource Management system (QuickTime Resource Manager on Mac and Windows) that has been deprecated and I have been using the current model that Qt uses where data is retrieved from the resource file using a string key. For example, I may have an image in my resource file, "HungryBear.png" stored in my...

Downloadable STL documentation that covers TR1?

For my offline coding needs, I've been using the downloadable STL documentation from SGI. Unfortunately it was last edited in 1999, and doesn't cover any of the TR1. It's easy enough to find online references for TR1, but can anybody recommend an easily downloadable TR1 reference for working offline? In HTML? I've downloaded Boost's ...

Are there Android SDK source code or at least old plain javadocs somewhere?

I'm new in Android development and I often need to look at javadocs on almost every single class or method from Android SDK. I found it very annoying to stop developing, go to the browser, look for the correspondent class and only then read the docs. It would be much more convenient to look at docs just in my IDE (for example, ctrl+cli...

software design specification

Hii.. I am making a project on Invoice Management System. Its an online system and I am using php for its coding. In my code I am not using any classes. So which diagram will be appropriate for me to include in Technical Specification Document(as I cant use any class diagram). Thanks in advance.... ...

How to add package level comments.

Hi All, I am using check-style, FindBug 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 am not able to understand it. Could some one help me ...