hegemonic

{
  "type": "RecordType",
  "fields": [
    {
      "type": "FieldType",
      "key": {
        "type": "NameExpression",
        "name": "animate"
      },
      "value": {

hegemonic

/**
 * @class MyClass
 */
function MyClass() {}

hegemonic

Syntax Proposal 1

1. Callbacks are documented in a @typedef.
2. If a parameter contains a callback function, its type should refer to the @typedef.
3. If a parameter refers to a @typedef for a Function, templates should give it special treatment. (This would probably necessitate adding a callback: true property to one of the doclets at parse time.)

Example

/**

hegemonic

{
  "type": "Program",
  "start": 20,
  "end": 193,
  "commentsBefore": [
    "* @constructor "
  ],
  "loc": {
    "start": {
      "line": 2,

hegemonic

[
    {
        "comment": "/** @constructor */",
        "meta": {
            "lineno": 2,
            "path": "tmp",
            "filename": "overload.js",
            "code": {
                "id": "astnode344078580",
                "name": "Person",

hegemonic

/** @constructor */
function Person() {
}

/**
    Set the person's name.
    @param {string} n - The name to set.
*//**
    Get the person's name
    @returns {string} The name.

hegemonic

[
    {
        "comment": "/** @constructor */",
        "meta": {
            "lineno": 2,
            "path": "tmp",
            "filename": "overload.js",
            "code": {
                "id": "astnode344078580",
                "name": "Person",

hegemonic

/** @constructor */
function Person() {
}

/**
    Set the person's name.
    @param {string} n - The name to set.
*//**
    Get the person's name
    @returns {string} The name.

hegemonic

[
    {
        "comment": "/**\n * Foo\n *\n * @name Foo\n * @constructor\n */",
        "meta": {
            "lineno": 1,
            "path": "tmp",
            "filename": "test.js",
            "code": {
            }
        },

hegemonic

{
    "classes": {
        "Foo": {
            "name": "Foo",
            "description": "",
            "extends": [
            ],
            "access": "",
            "virtual": false,
            "fires": "",