documentation

问题 I'm documenting the code for my company's iOS application, and now I've moved on to methods that have a completion handler. Is there a specific method for documenting completion handlers, or should I just put it as part of the parameters? for example: /** Description - Parameters: - parameter1: description - parameter2: description - completion: description */ Is this the right way or is there another better way? Or maybe it should be in the "Returns" part of the documentation? Thanks 回答1: /*

问题 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 2 years ago . I'm working on a C project that has seen many different authors and many different documentation styles. I'm a big fan of doxygen and other documentation generations tools, and I would like to migrate this project to use one of these systems. Is anybody aware of a tool that can scan source code comments for

问题 I know how to create a snippet by marking a section of an example file: //! [myfunc example] int i = myfunc(1,"example"); if (i = CORRECT_VALUE) printf("success"); //! [myfunc example] and then including that elsewhere with: /snippet mytestfile.c myfunc example In my case, my example files are my test files, and each example is actually already in a function, like this: void testMyFunc() { int i = myfunc(1,"example"); if (i = CORRECT_VALUE) printf("success"); } So what I want, is to be able

问题 Will the Sphinx documentation engine successfully generate documentation on a project that doesn't import well? In particular my project has an exotic dependency. I don't want document generation to depend on this dependency. Does Sphinx need to import my module and use introspection or does it parse? 回答1: If you're using the autodoc extension, then yes, your project must be importable. But sometimes it's possible to mock out dependencies in your conf.py (since, presumably, at the time of

问题 I've been adding docblocks to my code, and have resolved most of the build errors and warnings that the phpDocumentor script has generated and placed into the errors.html file. However, I have one last 'class' of warnings in my current documentation build - I get a warning for every class that I have documented in my application that inherits from an external library (in this case, Zend). Is there a way to stop warnings such as Warning - Class AMH_Controller_Action parent Zend_Controller

问题 I'm curious how it's possible to document the root package, displayed as the first page in a scala-doc compilation. Can one create a package object referring to the root-package somehow, or is are there any configuration options? The descriptions on the matter are somewhat vague. 回答1: There appears to be an option for scaladoc called -doc-root-content which was added in 2.9.2. You can see this in the ant build.xml for scala 2.9.2 and also in the compiler source code. It's not present in 2.9.1

问题 How I can define in sphinx which .rst files and directories should be used? I want to include an automatic documentation generator in my testing/building/documentation script. sphinx-quickstart was executed in my workspace and created an index.rst-file. As sphinx uses restructured text files for documentation I navigated through the workspace and create them manually with sphinx-autogen . It resulted into the tasks.rst file (see below). When I use 'make html' I get several warnings: WARNING :

问题 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 6 years ago . I'm looking for a comprehensive summary/reference of important properties of the various C++11 standard containers and container adapters (optionally also including boost/Qt), but indexed by those properties rather than the usual per container documentation (more on that below). The properties I have in mind

问题 i've activated warnings with doxygen WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = YES But undocumented methods like this one: void AnimationManager::setAnimationTimeStep( double timeStep ) { ... } Do not throw any warning during doxygen generation. Is there any way to display warning in this situation ? Same problem with undocumented return , for example /** * @brief brief description */ bool AnimationManager::hasAnimationTimeStep( ) { ... } Does not

问题 I have two fairly simple pieces of documentation(written in markdown that is used to generate html files with pandoc). I'd like to be able to link to a section of the second document from the first document. Preference order for solutions: Using General Markdown Features Using Pandoc Extensions Using embedded HTML 回答1: Pandoc has a "Header identifiers in HTML"-extension for this usecase. In the documentation is an example, how to provide links from one section of a document to another. 来源：