documentation-generation Questions
3
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 updat...
Subrogate asked 12/5, 2011 at 13:5
1
Solved
I'm looking for an equivalent of @describeIn that will allow me to create a single documentation object for multiple R data objects.
I had hoped that something like this:
#' Tree Distances
#'
#'...
Jasmin asked 7/8, 2019 at 8:43
2
My question is quite simple though I cannot find anything that points to it in the documentation.
I am generating documentation for a project with the default generator in Antora but I cannot figu...
Directorial asked 9/12, 2018 at 9:35
3
Solved
How can I tell JSDoc about the structure of an object that is returned. I have found the @return {{field1: type, field2: type, ...}} description syntax and tried it:
/**
* Returns a coordinate fr...
Gossipry asked 27/2, 2015 at 10:49
1
I tested Doxygen and multiple GitHub projects (jsdoc, react-docgen, react-doc-generator using npm i -g like:
react-doc-generator ./ -o DOCUMENTATION.md
react-docgen --pretty -o out/reactdocgen.htm...
Dacron asked 5/9, 2017 at 13:56
3
Solved
I'm using Sphinx for code documentation and use several languages within the code, I would like to setup highlighting for all of that code. Sphinx briefly mentions a few of the languages it support...
Inconsumable asked 3/7, 2012 at 16:48
3
Solved
My customer wants me to create a specification for a future REST API by using Enterprise Architect (SparxSystems). The deliverable should be well formatted text (can be html, docx or rtf). A class ...
Puissance asked 29/6, 2016 at 11:9
4
Solved
I have a .d.ts file with the interfaces describing my library. It has JSDoc comments, which will be shown via intellisense in Visual Studio when people refer to the .d.ts in their code:
/** Descri...
Grassi asked 19/5, 2013 at 15:42
2
Solved
I am using DocFx to automatically generate documentation in Visual Studio 2015.
Per the Getting Started instructions, I added an empty ASP.NET 4 Web Application and used the Nuget Console to inst...
Jacquline asked 23/2, 2016 at 22:2
3
Solved
In C#, I can attach documentation for properties, methods, events, and so on,
directly in the code using XML Documentation Comments.
I know how to insert a reference to a particular method:
<see...
Curkell asked 11/9, 2009 at 16:8
2
Solved
I have found how to give a group of class members a name:
/**\{
\name Foo
*/
members
/**
\}*/
, but how do I reference to Foo from other class members?
Klaipeda asked 17/4, 2013 at 11:14
3
Solved
I am working on documenting a new and expanded Lua API for the game Bitfighter (http://bitfighter.org). Our Lua object model is a subset of the C++ object model, and the methods exposed to Lua that...
Spherulite asked 12/9, 2012 at 12:40
5
I've been trying to document the following code using JSDoc:
/**
* @module person
*/
/**
* A human being.
* @class
* @param {string} name
*/
function Person(name){
this.name = name
}
Per...
Cubiform asked 7/12, 2014 at 13:33
1
I use Jekyll to create documentation for software products. I have 30 +
different products that have a common LIQUID template but different content. Every single product documentation has its own ...
Trochilus asked 19/1, 2018 at 10:40
8
Sphinx supports a few output formats:
Multiple HTML files (with html or dirhtml)
Latex which is useful for creating .pdf or .ps
text
How can I obtain output in a Microsoft Word file instead?
...
Bifacial asked 13/5, 2009 at 15:13
6
Solved
I have a django project, which I document using reST in docstrings to do the following:
Help diagloags within IDE
Later on to build HTML documentation using Sphinx
My documentation shows up pro...
Liturgical asked 11/10, 2011 at 23:8
3
Solved
I am to new to code documentation and trying to document my angular application with grunt-ngdocs.
I cloned a working example from: https://github.com/m7r/grunt-ngdocs-example
The given example ...
Stationmaster asked 15/12, 2015 at 20:43
4
Solved
I'm currently creating a phonegap app that lets you input Data and then creates a PDF with that data.
The Input is done, but I can't find anything to make a PDF with Javascript. So far I only found...
Gerick asked 23/1, 2014 at 10:36
1
I have a Python project in PyCharm and I'd like to automatically generate API documentation (in the form of HTML) from my Python code and docstrings.
According to this page, there are a numb...
Tremayne asked 27/6, 2016 at 22:40
4
I have a preexisting MVC app that I added Web API and Web API Self Documentation using Nuget. While the Web API controllers function fine (return valid responses to HTTP requests) the Help controll...
Mephitis asked 16/10, 2013 at 20:59
2
Solved
Is it possible to create aliases of protobuf's scalar types?
For example, I'd like to use Sequence in lieu of string, even though they would be binary equivalent.
My immediate goal is to make doc...
Liquesce asked 27/10, 2016 at 22:30
8
Does anyone know of a good tool to generate Google Protobuf documentation using the .proto source files?
Avignon asked 14/2, 2011 at 12:35
1
Solved
I'd like to import my .Net XML Documentation Comments (the documentation based on the code tags, automatically generated by the compiler with the /doc switch) into Atlassian Confluence.
I've used ...
Birdella asked 30/1, 2014 at 0:6
3
Solved
I have developed a C# class library which contains numerous projects. I am using this as a common library across multiple different projects.
A number of different developers have recently ...
Shutz asked 14/11, 2012 at 0:34
4
Solved
I've developed a pretty extensive API, and I have it on Postman, which works pretty nicely. Now I have to generate an html doc to keep it versioned inside /docs along with my sources.
Is ther...
Tinnitus asked 24/3, 2015 at 16:35
© 2022 - 2024 — McMap. All rights reserved.