search

AaronNGray / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Patch: Allow dash after name #270

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
The doc comments can get a bit complex when you start adding types and names 
and 
descriptions. Consider the following:

        @param {Object} parameters A hash representing connections between
            this controllers exposed bindings and the global context as well as
            any default parameters. Bindings are specified with a key ending in
            Binding.

Once the documentation is generated, this looks nice. But when reading the 
code, this can be a 
bit difficult to read. Attached find a patch that enables a dash between the 
name and the 
description. Like the following:

        @param {Object} [parameters] - A hash representing connections between
            this controllers exposed bindings and the global context as well as
            any default parameters. Bindings are specified with a key ending in
            Binding.

The dash is only removed when it appears on the same line as the name. For 
example, this tag 
would not have the dash removed:

        @param {Object} [parameters]
            - A hash representing connections between
            this controllers exposed bindings and the global context as well as
            any default parameters. Bindings are specified with a key ending in
            Binding.

Original issue reported on code.google.com by jeff%met...@gtempaccount.com on 23 Nov 2009 at 5:59

Attachments:

GoogleCodeExporter commented 9 years ago

Original comment by micmath on 23 Nov 2009 at 9:38

GoogleCodeExporter commented 9 years ago 
Committed in revision 843. Thank you for your patch!

Original comment by micmath on 27 Jun 2010 at 8:55