Doc updates (#791)
Updates for better displaying the documentation in the website.
This commit is contained in:
committed by
delvedor
parent
3a1bb9377a
commit
4537308c38
@ -22,7 +22,15 @@
|
||||
const dedent = require('dedent')
|
||||
|
||||
function generateDocs (common, spec) {
|
||||
var doc = '= API Reference\n\n'
|
||||
var doc = dedent`
|
||||
== API Reference
|
||||
|
||||
////////
|
||||
|
||||
This documentation is generated by running:
|
||||
node scripts/run.js --tag v7.0.0-beta
|
||||
|
||||
////////\n\n`
|
||||
doc += commonParameters(common)
|
||||
spec.forEach(s => {
|
||||
doc += '\n' + generateApiDoc(s)
|
||||
@ -105,27 +113,29 @@ function generateApiDoc (spec) {
|
||||
----
|
||||
client.${camelify(name)}([params] [, options] [, callback])
|
||||
----
|
||||
${documentationUrl || ''}
|
||||
[cols=2*]
|
||||
|===`
|
||||
${documentationUrl || ''}\n`
|
||||
|
||||
doc += '\n' + params.reduce((acc, val) => {
|
||||
const name = isSnakeCased(val.name) && val.name !== camelify(val.name)
|
||||
? '`' + val.name + '` or `' + camelify(val.name) + '`'
|
||||
: '`' + val.name + '`'
|
||||
acc += dedent`
|
||||
|${name}
|
||||
|${'`' + val.type + '`'} - ${val.description}`
|
||||
if (val.default) {
|
||||
acc += ` +
|
||||
_Default:_ ${'`' + val.default + '`'}`
|
||||
}
|
||||
return acc + '\n\n'
|
||||
}, '')
|
||||
if (params.length !== 0) {
|
||||
doc += dedent`[cols=2*]
|
||||
|===\n`
|
||||
doc += params.reduce((acc, val) => {
|
||||
const name = isSnakeCased(val.name) && val.name !== camelify(val.name)
|
||||
? '`' + val.name + '` or `' + camelify(val.name) + '`'
|
||||
: '`' + val.name + '`'
|
||||
acc += dedent`
|
||||
|${name}
|
||||
|${'`' + val.type + '`'} - ${val.description}`
|
||||
if (val.default) {
|
||||
acc += ` +\n_Default:_ ${'`' + val.default + '`'}`
|
||||
}
|
||||
return acc + '\n\n'
|
||||
}, '')
|
||||
|
||||
doc += dedent`
|
||||
|===
|
||||
`
|
||||
doc += dedent`
|
||||
|===
|
||||
`
|
||||
}
|
||||
doc += '\n'
|
||||
return doc
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user