diff --git a/scripts/docs/dgeni-config.js b/scripts/docs/dgeni-config.js index 992094914..f93618ab3 100644 --- a/scripts/docs/dgeni-config.js +++ b/scripts/docs/dgeni-config.js @@ -14,6 +14,7 @@ module.exports = currentVersion => { .processor(require('./processors/remove-private-members')) .processor(require('./processors/hide-private-api')) .processor(require('./processors/parse-optional')) + .processor(require('./processors/mark-properties')) .processor(require('./processors/npm-id')) .processor(require('./processors/jekyll')) diff --git a/scripts/docs/processors/mark-properties.js b/scripts/docs/processors/mark-properties.js new file mode 100644 index 000000000..ed132d48e --- /dev/null +++ b/scripts/docs/processors/mark-properties.js @@ -0,0 +1,15 @@ +"use strict"; +module.exports = function markProperties() { + return { + name: 'mark-properties', + $runBefore: ['rendering-docs'], + $process: docs => docs.map(doc => { + for (let i in doc.members) { + if (doc.members.hasOwnProperty(i) && typeof doc.members[i].parameters === 'undefined') { + doc.members[i].isProperty = true; + } + } + return doc; + }) + } +}; diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 282a4239b..9f64a3597 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -10,6 +10,7 @@ header_sub_title: "<$ doc.docType | capital $> in module <$ doc.module $>" doc: "<$ doc.name $>" docType: "<$ doc.docType $>" --- + <@- macro interfaceTable(interface) -@> <@ for export in doc.moduleDoc.exports -@> <@ if export.name == interface @> @@ -78,12 +79,11 @@ docType: "<$ doc.docType $>" <@- macro functionSyntax(fn) @> <@- set sep = joiner(', ') -@> <$ fn.name $><@- if not fn.isProperty @>(<@ endif -@><@- for param in fn.params @><$ sep() $> - <@- if param.type.optional @>[<@ endif -@> + <@- if param.type.optional @>[<@- endif -@> <$ param.name $> - <@- if param.type.optional @>]<@ endif -@> - <@ endfor @><@- if not fn.isProperty @>)<@ endif -@> - <@ if fn.alias @>(alias: <$ fn.alias $>)<@ endif @> -<@ endmacro -@> + <@- if param.type.optional -@>]<@- endif -@> + <@- endfor -@><@- if not fn.isProperty @>)<@- endif -@> +<@- endmacro -@> <@- macro typeList(types) -@> <@ set separator = joiner("|") @> @@ -109,7 +109,7 @@ docType: "<$ doc.docType $>" <@- endif @> <@- endmacro -@> -<@- macro documentMethod(method) -@> +<@ macro documentMethod(method) -@>

<$ functionSyntax(method) $>

<$ documentPlatforms(method) $> <$ method.description $> @@ -141,28 +141,9 @@ docType: "<$ doc.docType $>" <$ documentMethod(method) $> <@- endfor @> <@- endif -@> -<@- endmacro -@> +<@ endmacro @> -

- <@ if doc.docType == "directive" @> - <$ doc.name | dashCase $> - <@ else @> - <$ doc.name $> - <@ endif @> - - <@ if doc.parent @> -
- - Child of <$ doc.parent $> - - <@ endif @> - - <@ if doc.delegate @> -
- - Delegate: <$ doc.delegate $> - - <@ endif @> +

<$ doc.name $> <@- if doc.beta == true -@> β <@- endif -@> @@ -182,6 +163,8 @@ docType: "<$ doc.docType $>" href="<$ prop.repo $>/issues">plugin repo.

<@ endif @> + +<# --- Install commands --- #>
$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plugin $><@ endif @>
 $ npm install --save @ionic-native/<$ doc.npmId $>