documentation

I am working to document a visualization function in a package of mine. For this purpose I would like to have an image embedded through the Rd-file 'funcname.Rd' that could explain various parameters utilized in the function, and which would pop up if user goes to read the package manual PDF or writes '?funcname' in R. Something in the lines of: 'Writing R extensions'-document doesn't seem to address this issue, and the only references I could find were this blog post and this R-devel discussion . The former has a broken link to a package called 'base64' and the latter only addresses various

I ran into following problem already multiple times. Say you have two classes, classA and classB described in the following files classA.R : #' the class classA #' #' This is a class A blabla #' \section{Slots}{\describe{\item{\code{A}}{a Character}}} #' @ name classA #' @rdname classA #' @exportClass classA setClass("classA",representation(A="character")) And classB.R #' the class classB #' #' This is a class B blabla #' \section{Slots}{\describe{\item{\code{B}}{an object of class A}}} #' @ name classB #' @rdname classB #' @exportClass classB setClass("classB",representation(B="classA")) I

I am currently working developing a C++-based module for Python. I have found that Boost::Python is working quite well for what I want to accomplish. However, I am now running into some issues with the docstring that is being generated by Boost::Python. Given the following Boost::Python definitions: BOOST_PYTHON_MODULE(gcsmt) { class_<gcsmt::Units>("Units", "Sets the units used as input.", no_init) .def("PrintSupported", &gcsmt::Units::printSupported, "Print out all supported units.") .def("SetDefault", &gcsmt::Units::setDefaultUnit, "Sets the default unit to be used for inputs/outputs.")

I have a C# project in vs2010 that generates a XML documentation file, where I have set the output path of the generated file to the project output path. My problem is that the file does not update when the path to the document file is the same as project output path, and the file names are the same (except for the file extensions). Does not update XML file: C:\MyProjectFolder\MyProject.dll C:\MyProjectFolder\MyProject.xml (documentation file) But when I change either to another folder or change the documentation file name, the file is generated correctly. Does update XML file: C:

The question is quite simple - how should I differ phpdoc for interface and for class implementing interface? Should/Can they be the same or maybe interface documentation should be as general as possible and class implementing this interface more specific? I include one method phpDoc from my real code: My interface: interface CacheInterface { /** * Adds data to cache * * @param string $objectId Name of object to store in cache * @param mixed $objectValue Data to store in cache * @param mixed $lifetime Lifetime of cache file * @param string $group Name of cache group. * @param array $params

Is there a way to use RTL (Right to left, like farsi, arabic, ...) text in sphinx ? When generating html from .rst files, the generated html is LTR(Left to right by default) and aligned left, and my question is how I can change it, and make it RTL, and be aligned right. Thanks for your reply. You can check python's docutils FAQ . It explains how to use css and classes to mark text direction. As mentioned in this answer you can use css. In put a text in center and Right to left numbering problem , I mentioned that you can use class names like rtl and ltr for changing the direction of texts. My

When building html documentation, how do you force sphinx to report, or create an error, on links that don't exist? Specifically, I have properties and methods within my Python project that have been removed or renamed, and it is hard to find all the dead links with the sphinx generated html output. I feel like I'm staring at the answer here: http://sphinx-doc.org/glossary.html , as descriped in the opening paragraph. I'm obviously not understanding something. mzjn Set the nitpicky configuration variable to True (you can also use the -n option when running sphinx-build). In nitpicky mode, a

The ampoule project uses some tags in docstring, like the javadoc ones. For example from pool.py line 86: def start(self, ampChild=None): """ Starts the ProcessPool with a given child protocol. @param ampChild: a L{ampoule.child.AMPChild} subclass. @type ampChild: L{ampoule.child.AMPChild} subclass """ What are these tags, which tool uses it. Markup for a documentation tool, probably epydoc . cdleary Just for fun I'll note that the Python standard library is using Sphinx/reStructuredText, whose info field lists are similar. def start(self, ampChild=None): """Starts the ProcessPool with a given