File: user_doc.txt

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (28 lines) | stat: -rw-r--r-- 519 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 

userDoc( alias, [ref,] doc )
    Adds user-defined documentation.

    If user-defined documentation already exists for the provided alias, the
    current documentation is overwritten.

    Parameters
    ----------
    alias: string
        Documentation alias.

    ref: any (optional)
        Object reference.

    doc: string
        Documentation.

    Examples
    --------
    > function foo() {};
    > userDoc( 'foo', foo, '\nfoo()\n    Foo bar.\n' );
    > help( foo )

    See Also
    --------
    help