documentation

I want to document Python object attributes with Sphinx. I understand I should use :ivar varname: description :ivar type varname: description However I'm seeing a weird behaviour, that is Sphinx searches my project for the variable name and tries to create symlinks. E.g. this code: class A(object): """ :ivar x: some description """ def __init__(self, x): self.x = x class B(object): def x(self): return 1 class C(object): def x(self): return 2 will cause this error: module1.py:docstring of mylibrary.module1.A:None: WARNING: more than one target found for cross-reference u'x': mylibrary.module1.C

I want that when i mouse over a method i would be able to see my documentation of what the method does like when i put the mouse over Java's method I know that /** */ is how its done but: How do you explain what the Params Stands for? How do you create a new line, or make a word bold or italic? Peter Ilfrich If you're using Eclipse as IDE, you just need to create a comment with /** and press enter and it will generate your code for your Javadoc, including parameters, return values, etc. You just need to put in the descriptions. The same applies for class declarations (the Javadoc comment

A simple example is that I have created an extension to show , which is a S4 base method. I don't want to cause a disambiguation fork by re-documenting show in my package, and I also want to consolidate the documentation of my extension to show in the documentation for the new class, myPkgSpClass , by adding an alias for show,myPkgSpClass-method . #' @export #' @aliases show,myPkgSpClass-method #' @rdname myPkgSpClass-class setMethod("show", "myPkgSpClass", function(object){ show(NA) }) The problem I'm having, is that this results in an serious warning during documentation-build by roxygen2,

The entire documentation for the Fragment.onCreateAnimator(int, boolean, int) method consists of the following text: "Called when a fragment loads an animation." That's it. No explanation about the parameters. What do the parameters mean? Even the source code doesn't reveal much. The onCreateAnimator method is odd. The prototype I've seen is this: public Animator onCreateAnimator(int transit, boolean enter, int nextAnim) int transit - transition type, as sandrstar said above boolean enter - true if 'entering,' false otherwise int nextAnim - The resource ID of the animation that is about to

We have a large framework created using VB Script, which has been created and then maintained for the past few years. This code was initially well documented and all the initial functions and variables and files had good headers in them. Later in maintainence, the code got obfuscated by the coders not keeping track of new and changed functionality and the final result now in my hands is a code which has around ~600 files and none of them have the proper description of the functions and variables in them :-( Could someone inform if they have created documents (on the fly types - dOxygen, etc.)

An obvious answer is "an internal wiki". What are the pros and cons of a wiki used for software documentation? Any other suggestions? What are you using for your software documentation? Loren Segal - Unfortunately we don't have support for any doc tool to compile information from the source code comments but I agree it would be the best way to store technical documentation. My question was about every kind of documentation tho - from sysadmin type to user documentation. That's a very open ended question, and depends on many factors. Generally speaking, if you use a language that has good