documentation-generation

Scaladoc [use case]

不问归期 提交于 2019-11-29 06:00:18
Why do some method descriptions in Scaladoc start with [use case] ? Example: scala.collection.immutable.StringOps.++ Is it just a placeholder to be replaced in the future? They are simplified examples of how these methods are called. Usually these methods ( ++ , map , flatMap , etc.) contain an implicit parameter, most often an argument called a builder factory which (simply put) abstracts creation of resulting collections. In most cases, a client of a collection does not specify these implicit parameters, so ScalaDoc allows defining a simplified description of the method - a use case . This

Anything better than PHPDoc out there? [closed]

末鹿安然 提交于 2019-11-28 22:29:26
问题 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 4 years ago . 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? 回答1: I´ll go for doxygen too. Here are several reasons : compatible with phpdoc tags and other popular ones : it´s interoperable works with various

Auto documenting REST API in PHP

早过忘川 提交于 2019-11-28 20:15:44
问题 phpDocumentor seems to be the standard for documenting PHP code, though I have to wonder why it hasn't been updated in years..? However, it does not seem suitable for documenting the entry points for a REST API; IE, externally accessible entry points that an end user of your system would be interested in, as opposed to documenting all the internal classes and such - something only of interest to the developers of the api. I am looking for something where I could say, hey this method here is

Documenting C++/CLI library code for use from c# - best tools and practices? [closed]

ε祈祈猫儿з 提交于 2019-11-28 18:26:59
问题 Closed . This question is opinion-based. It is not currently accepting answers. Want to improve this question? Update the question so it can be answered with facts and citations by editing this post. Closed last year . I'm working on a project where a c++/cli library is being used primarily from a c# application. Is there any way to make the code comments in c++/cli visible to c# intellisence within visual studio? Assuming there isn't, what would be the best way to document the c++/cli code

What is the Mathworks way to generate Matlab HTML documentation?

北城余情 提交于 2019-11-28 17:32:26
I am working on shared Matlab code and we would like to share a generated documentation as searchable HTML documents within our local network. I know of the following methods to generate a documentation: Write a converter to C++-like files. This is done in in Using Doxygen with Matlab (Last updated 2011) and mtoc++ (last updated 2013). The C++-like files are then parsed by Doxygen. Use Python's sphinxcontrib-matlabdomain to generate a HTML documentation. Use m2html which is also a third-party solution. Further options are listed in this Q&As: One , Two and Three . All possibilities are not

Is there a way to generate Javascript API documentation like the Google Closure Library API Documentation?

左心房为你撑大大i 提交于 2019-11-28 17:11:05
问题 I'm trying to find a tool that generates HTML documentation for my Javascript source code. Does anyone know if the tool that Google uses to generate the interface at the following URLs is open source? Would I be able to generate similar output? http://closure-library.googlecode.com/svn/docs/class_goog_proto2_Serializer.html http://closure-library.googlecode.com/svn/docs/namespace_goog_date.html http://closure-library.googlecode.com/svn/docs/namespace_goog_events.html http://closure-library

How to document a method with parameter(s)?

…衆ロ難τιáo~ 提交于 2019-11-28 13:46:33
问题 How to document methods with parameters using Python's documentation strings? EDIT: PEP 257 gives this example: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... Is this the convention used by most Python developers ? Keyword arguments: <parameter name> -- Definition (default value if any) I was expecting something a little bit

Can't install phpDocumentor via Composer

房东的猫 提交于 2019-11-28 07:32:26
问题 In composer.json I've got { "require": { "phpdocumentor/phpdocumentor": "*" } } It's what is there because I'm trying to install phpDocumentor into an isolated folder with ./composer.phar install command. But what I'm getting is Loading composer repositories with package information Updating dependencies (including require-dev) Your requirements could not be resolved to an installable set of packages. Problem 1 - phpdocumentor/phpdocumentor v2.0.0 requires phpdocumentor/template-abstract ~1.2

UmlGraph vs APIViz for Maven javadoc generation

时光总嘲笑我的痴心妄想 提交于 2019-11-28 04:49:38
问题 I'm wondering if there are any clear reasons to choose UmlGraph over APIViz for javadoc UML diagram generation in a Maven2 build. Are there any integration or features that one has over the other, they seem pretty similar? 回答1: There is an interesting thread here about UMLGraph vs apiviz (which are mentioned in this question on SO too) and my understanding is the following: UMLGraph is older but is really nice (dixit Fowler which has more weight than me). apiviz is a rewrite of UMLGraph but

Automatic PHP Documentation Generation? [closed]

我与影子孤独终老i 提交于 2019-11-28 03:20:21
For ActionScript 2, I've used NaturalDocs . However it has pretty poor support for PHP. I've looked so far at doxygen and phpDocumentor , but their output is pretty ugly in my opinion. Does anyone have any experience with automatic documentation generation for PHP? I'd prefer to be able to use javadoc-style tags, they are short to write and easy to remember. ApiGen http://apigen.org/ ApiGen has support for PHP 5.3 namespaces, packages, linking between documentation, cross referencing to PHP standard classes and general documentation, creation of highlighted source code and experimental support