Stack Overflow
Stack Overflow

Questions tagged [docco]

Docco is a documentation generator for CoffeeScript that takes comments in the CoffeeScript source and generates Markdown-based documentation that is shown alongside the comment-free source.

Docco is a documentation generator for coffeescript that takes comments in the coffeescript source and generates markdown based documentation that is shown alongside the comment free source.

Project site: Docco

GitHub home: Docco Github Page

17 questions
4
votes
1 answer

Naming sections with docco/markdown?

Using CoffeeScript and Docco, sections are created in the generated HTML which can then be used as links eg. geometry.html#section-82 Does anyone know if there is a way to name these sections so it could instead be (for…
phenomnomnominal
  • 5,427
  • 1
  • 30
  • 48
3
votes
3 answers

Is there a source code documentation generator for C / C++ like docco?

I would like the get a similar output on documented c++ implementation files (not header files) like the output generated with docco. Is there such a tool?
Lars Bilke
  • 4,940
  • 6
  • 45
  • 63
3
votes
1 answer

Docco ignore blocks of comments

I am using docco as a tool for creating coffeescript documentation. By default, every comment I make in coffeescript source is treated as documentation and moved to the left (explainatory) column. The problem is, in my source there are some lines of…
Jack L.
  • 1,257
  • 2
  • 17
  • 37
3
votes
3 answers

Marginalia / Docco / etc for Java Maven projects?

Is it possible to run Marginalia on a Java (multi-module) project which uses Maven? Or is there any other alternative that's similar to Marginalia or Docco that can do this? What's important to me is to be able to add it as a dependency from some…
Martin Spa
  • 1,494
  • 1
  • 24
  • 44
2
votes
2 answers

Hiding Commented code for Docco from SonarQube review

Our organization is using SonarQube for managing code quality as well as Docco for handling production of documentation from code comments. We're running into a conflict between including things like method names in comments for Docco and the…
Dale
  • 21
  • 3
1
vote
1 answer

Have Pycco recognize doctests as code?

Is there any way to have Pycco recognize doctests as code and render them appropriately? E.g. the docstring of the following function def fib(i): """ Fibonacci number >>> fib(10) 55 """ if i < 2: return i else: …
MRocklin
  • 55,641
  • 23
  • 163
  • 235
1
vote
0 answers

Ignoring blocks of text with Docco

Using Docco (latest) via Grunt (grunt-docco) against JavaScript code. How can blocks of text be ignored? For example, at the top of all JavaScript files is license info in multi-line comments: /** Copyright 2014.... */ Or let's say I have code…
Matthew Campbell
  • 1,864
  • 3
  • 24
  • 51
1
vote
2 answers

A better way to organize Docco pages

I have a large Backbone-style application (~100 files), and I'm trying to select the best method to automate documentation. I'm experimenting with docco, (with grunt-docco2) but I'm running into issues. With all the files I have list on the left,…
streetlight
  • 5,968
  • 13
  • 62
  • 101
1
vote
1 answer

How to send files from folder recursively to command in linux console?

I want to generate docs for coffee-script files. I want to use Docco. When i use: docco client/coffee/* it throws error. I think because folders are in file list. When i use: docco client/coffee/*.coffee it cant' find some files, because i havent…
nkuhta
  • 10,388
  • 12
  • 41
  • 54
1
vote
1 answer

grunt-dox generating html file with only title

I'm using the grunt-dox grunt plugin to generate docco documentation out of a JavaScript file that has JsDoc dockblocks. When I run the grunt task all I get is an HTML file with just the title I specified. No errors installing grunt-dox or running…
Julia Anne Jacobs
  • 508
  • 1
  • 4
  • 20
1
vote
1 answer

Ant Task to create docs directory tree with docco

I have an ant file to generate coffeescript documentation with docco. It works fine, except that it currently dumps all of the documentation file into the docs folder. I'd like the docs folder to mirror the structure of my scripts directory,…
Ben McCormick
  • 25,260
  • 12
  • 52
  • 71
0
votes
1 answer

How to represent Function names in Docco generated files?

The objective is to make the docco generated documentation for fluentnode (written in Coffee-Script) as easy to read and understand as possible. At the moment I'm struggling with the best way to represent the function names on the left hand side of…
Dinis Cruz
  • 4,161
  • 2
  • 31
  • 49
0
votes
1 answer

R Markdown with the DOCCO linear style

I was about to write a package's vignette using DOCCO linear style that is supported by knitr package (knitr). In their example vignette there appears a nice graphic at the begging and at the end of HTML file. But when I tried to maintain my own…
Marcin
  • 7,834
  • 8
  • 52
  • 99
0
votes
1 answer

How do I change the title of an HTML page generated by Docco?

Currently the title of any HTML page generated by Docco will be the name of the source code file. How do I change that? I would like to set a custom title for my generated code.
Shahar
  • 800
  • 8
  • 10
0
votes
0 answers

Pass Options to Marked from Docco

I'm using grunt-docco (https://github.com/DavidSouther/grunt-docco) which runs docco on a project in a Grunt workflow. However, I've ran into an issue (https://github.com/DavidSouther/grunt-docco/issues/34) involving passing options to Marked…
streetlight
  • 5,968
  • 13
  • 62
  • 101
1
2