47 lines
1.3 KiB
Text
47 lines
1.3 KiB
Text
#
|
|
# Configuration file for JSDoc
|
|
#
|
|
# The following hashes are used for supplying user-defined @attribute tags
|
|
# that will be parsed. Non-standard attributes (such as @subclass) can be
|
|
# added into these hashes, along with a code reference. The return value
|
|
# from the code reference will be included in the documentation. All
|
|
# non-standard tags that are not in the below hashes will be ignored.
|
|
# The code reference will receive a reference to an array of
|
|
# values that were supplied with the @... tag
|
|
#
|
|
|
|
# Class attributes
|
|
#eval {
|
|
# $CLASS_ATTRS_MAP{subclass} =
|
|
# # subclass is the name of the @... tag
|
|
# sub {
|
|
# # Body from which a string is returned
|
|
# '<DT><B>Subclasses:</B><DD>-' .
|
|
# join('<DD>-',
|
|
# map ({"<A HREF=\"$_.html\">$_</A>"}
|
|
# map ( { s/\s*(\w+)\s*/$1/; $_} @{@_->[0]})
|
|
# )
|
|
# ) . '<P>'
|
|
# };
|
|
#
|
|
# $CLASS_ATTRS_MAP{with} =
|
|
# sub {
|
|
# 'This class has a \'@with\' attribute'
|
|
# };
|
|
#};
|
|
|
|
# Method attributes
|
|
# eval {
|
|
#
|
|
# Uncomment this to allow the filename to be displayed for
|
|
# each function
|
|
#
|
|
# $METHOD_ATTRS_MAP{filename} =
|
|
# sub {
|
|
# '<DT><B>Filename:</B> ' . $_[0] . '<P>'
|
|
# };
|
|
# $CLASS_ATTRS_MAP{filename} = $METHOD_ATTRS_MAP{filename};
|
|
#
|
|
# };
|
|
#
|
|
|