Customise output about docblockr HOT 8 OPEN

Docblockr already has a few configurations to change the output style and all of them are error-prone, because this configurations have to be considered in many places.
But customizing the output is a heavily requested feature. Currently these issues request a more specific but similar functionality:

• #128
• #144
• #150
• #164

We should think about how to realize these customizations without introducing too many special cases.

from docblockr.

I personally prefer this:

/**
 * @function [function name]
 *
 * @brief    [brief description]
 * @detail   [detailed descr]
 *
 * @param    {type} {name} [descr]
 *  "..."
 * @return   {type} [descr]
 *
 * @pre      [precondition]
 * @post     [postcondition]
 *
 * @author   [name]
 * @email    [email]
 */

So I hope you see my desire to customise the output.

from docblockr.

I would also like to customise the output, although I rather want to have less info, in contrast to @awesomefireduck.

from docblockr.

It would also be nice to be able to customize the tag format.

We use Sphinx, which uses the following format:

/**
 * Brief description.
 *
 * Longer description.
 *
 * :param parameterA: Parameter description.
 * :param parameterB: Parameter description.
 *
 * :returns: Description of return value.
 */

@return can already be customized, but @param and others can't be.

Also, customizing the "trigger" (/**) would be nice. We have an internal tool, which actually uses /*!.

from docblockr.

We write coffeescript and use codo as doc generator, it would be nice to be able to customize the form of comments. Replace the * with #

    # Given a obj and a nested keyname, return the value
    # Safe from errors
    # @param {Object} obj
    # @param {String} key
    # @return by default is undefined
    getVal = (obj, key) ->
      unless obj then return obj
      keyAttr = key.split('.')
      val = obj

      for k in keyAttr
        if val and val.hasOwnProperty(k)
          val = val[k]
        else
          return undefined
      val

from docblockr.

I no longer use Atom, so this isn't an issue for me.
Good luck with this!

from docblockr.

I still use it with dockblockr and would appreciate this feature.

from docblockr.

#223 is also relevant to this

from docblockr.