@@ -4,7 +4,7 @@ const inflection = require('inflection');
4
4
5
5
let knownClassNames = [ ] ;
6
6
7
- const anchorName = ( link ) => inflection . dasherize ( inflection . underscore ( link ) ) ;
7
+ const anchorName = ( link ) => inflection . dasherize ( inflection . underscore ( link . replace ( / # / g , '-' ) ) ) ;
8
8
9
9
const resolveInlineLinks = str => {
10
10
return inline . replaceInlineTags ( str , {
@@ -25,13 +25,25 @@ const renderLinks = (p) => {
25
25
return p ;
26
26
} ;
27
27
28
+ function generateParams ( doclet ) {
29
+ const params = doclet . params . map (
30
+ p => {
31
+ const optional = p . optional ? `**Optional**` : null ;
32
+ const defaultValue = p . defaultvalue ? `**Default:** \`${ p . defaultvalue } \`` : null ;
33
+ const options = [ optional , defaultValue ] . filter ( f => ! ! f ) ;
34
+ return `- \`${ p . name } \`${ options . length ? ` (${ options . join ( ', ' ) } )` : '' } ${ p . description ? ` - ${ resolveInlineLinks ( p . description ) } ` : '' } ` ;
35
+ }
36
+ ) ;
37
+ return `**Parameters:**\n\n${ params . join ( '\n' ) } \n` ;
38
+ }
39
+
28
40
const generateFunctionDocletSection = ( doclet ) => {
29
41
const title = doclet . name ;
30
42
const header = `##${ doclet . longname . indexOf ( '#' ) !== - 1 ? '#' : '' } ${ title } \n` ;
31
43
const signature = `\`${ doclet . meta . code . name || doclet . name } (${ doclet . params && doclet . params . filter ( p => p . name . indexOf ( '.' ) === - 1 ) . map ( p => p . name ) . join ( ', ' ) || '' } )\`\n` ;
32
- const params = doclet . params ? `**Parameters:**\n\n ${ doclet . params . map ( p => `- \` ${ p . name } \` ${ p . description ? ` - ${ p . description } ` : '' } ` ) . join ( '\n' ) } \n` : `` ;
44
+ const params = doclet . params ? generateParams ( doclet ) : `` ;
33
45
const returns = doclet . returns ? `**Returns:** ${ doclet . returns . map ( p => `${ p . type ? renderLinks ( p ) : '' } ${ p . description ? ` ${ resolveInlineLinks ( p . description ) } ` : '' } ` ) } ` : `` ;
34
- return [ header , signature , `${ doclet . description } \n` , params , returns , '\n' ] . join ( '\n' ) ;
46
+ return [ header , signature , `${ resolveInlineLinks ( doclet . description ) } \n` , params , returns , '\n' ] . join ( '\n' ) ;
35
47
} ;
36
48
37
49
const generateClassSection = ( doclet ) => {
0 commit comments