documentation

Documenting setter functions with roxygen

由 那年仲夏 提交于 2019-11-30 04:45:22
问题 I have a function that does nothing more than ads a unique attr to any R object. Base demo: #' Setter function #' @param x an R object #' @param value a character value to set #' @export `foo<-` <- function(x, value){ attr(x, 'foo') <- value return(x) } This works like a charm except for generating a good Rd file, relevant part: \usage{ foo(var, value) <- value } And of course it triggers a warning while running R CMD check as it should be foo(var) <- value . Any hints would be really

Can Eclipse hover tips display Doxygen comments from header file?

由 萝らか妹 提交于 2019-11-30 04:32:23
I'm using Eclipse CDT to write C++ code. Having read several discussions here on StackOverflow about whether to place doxygen documentation in the header file or the implementation file, it seems the majority of developers favour putting doxygen comments in the header file (although it's by no means a consensus, of course). However, if I put doxygen comments in my header files, I can't get Eclipse to display those comments when I hover the mouse pointer over an instance of the commented method/member. Is there a way to get Eclipse to make use of my Doxygen documentation from my header files in

How to document fields and properties in Python?

由 烂漫一生 提交于 2019-11-30 04:11:03
It's easy to document a class or method in Python: class Something: """ Description of the class. """ def do_it(self): """ Description of the method. """ pass class_variable = 1 # How to comment? @property def give_me_some_special_dict(self): """ doesn't work! Doc of general dict will be shown. """ return {} But how to document a field or property for usage in API docs or help ? Eli Bendersky Python has a PEP ( 257 ) that defines Docstring Conventions. Regarding documentation of attributes, it states: String literals occurring immediately after a simple assignment at the top level of a module,

Is there a good way to produce documentation for swig interfaces?

由 ￡可爱￡侵袭症＋ 提交于 2019-11-30 03:38:23
问题 I'd like to know if there are any good techniques for constructing/maintaining documentation on the interface. I'm building an interface from c++ code to python using swig; mostly I'm just %including the c++ header files. I'm dealing with at least dozens of classes and 100's of functions, so automated tools are preferred. Ideally, I'd like to use the doxygen formatted comments in the c++ headers to populate the docstrings in the python classes/methods. Alternately, generating separate

Is there a command line C++ to PDF converter with syntax highlighting? [closed]

由 荒凉一梦 提交于 2019-11-30 03:29:36
I need to supply "Source code documents w/ Line numbers" which is essentially just a PDF of the source code with syntax highlighting and Line numbers. Is there any existing command line tools for windows that I could call from a script as a "build release version" script? Right now I'm doing it manually using VC++, which isn't even the dev enviroment the code is for a TI processor, and a PDF printer driver, which has a pop up for each file I print. Two syntax highlighters I use are enscript and source-highlight . The first can output to PostScript (that you can convert to PDF using ps2pdf),

Using Doxygen with C, do you comment the function prototype or the definition? Or both?

由 落爺英雄遲暮 提交于 2019-11-30 03:00:39
I'm using Doxygen with some embedded C source. Given a .c/.h file pair, do you put Doxygen comments on the function prototype (.h file) or the function definition (.c file), or do you duplicate them in both places? I'm having a problem in which Doxygen is warning about missing comments when I document in one place but not the other; is this expected, or is my Doxygen screwed up? gimpf For public APIs I document at the declaration, as this is where the user usually looks first if not using the doxygen output. I never had problems with only documenting on one place only, but I used it with C++;

Xcode and XIB self documentation [closed]

由 瘦欲@ 提交于 2019-11-30 02:58:57
问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed last year . Is there a tool for documenting the many Xcode bindings, outlet and IBAction bindings, key value bindings, etc? I have looked at the threads on Doxygen and HeaderDoc, but these document program files, to describe classes etc, but don't seem to cover the huge number of 'hidden' linkages that Xcode drag-and-drop

How do I set the language for the Android developer website? [closed]

由 主宰稳场 提交于 2019-11-30 02:32:59
When I attempt to navigate to the Android developer website, I am redirected to a version of it much of which is in Chinese. For instance, if I try to navigate to: developer.android.com I am redirected to: http://developer.android.com/intl/zh-cn/index.html I want the English language site. In some cases, I've had to have web pages translated from Chinese. What am I doing wrong? How can I suppress this behavior? While CommonsWare's answer will work just fine because removing the cookie will reset the language back to the default (English), the proper way to change the language of the Android

Python C extension: method signatures for documentation?

由 ⅰ亾dé卋堺 提交于 2019-11-30 01:46:11
问题 I am writing C extensions, and I'd like to make the signature of my methods visible for introspection. static PyObject* foo(PyObject *self, PyObject *args) { /* blabla [...] */ } PyDoc_STRVAR( foo_doc, "Great example function\n" "Arguments: (timeout, flags=None)\n" "Doc blahblah doc doc doc."); static PyMethodDef methods[] = { {"foo", foo, METH_VARARGS, foo_doc}, {NULL}, }; PyMODINIT_FUNC init_myexample(void) { (void) Py_InitModule3("_myexample", methods, "a simple example module"); } Now if

Anything better than PHPDoc out there? [closed]

由 倖福魔咒の 提交于 2019-11-30 01:43:31
Does anybody use anything else to document their PHP code than PHPDoc? Are there any tools that read the same documentation syntax but give richer output? I´ll go for doxygen too. Here are several reasons : compatible with phpdoc tags and other popular ones : it´s interoperable works with various programming languages : a better time investment there is alternative syntaxes : can choose the commenting style that suit you very efficient with advanced formating / tagging / metadata there is a GUI that is not linked to any IDE and an eclipse plugin as well And still free, multiplatform, and open
订阅 documentation