github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-02-07 23:03:19 +08:00
Code Issues Projects Releases Wiki Activity

chore(docs): add beta warning to docs pages

Browse Source
This commit is contained in:
perry 2017-01-11 13:00:52 -06:00
parent 1134ac96b6
commit 5c7d7ac527
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
scripts/docs/processors/collect-inputs-outputs.js
View File

@ -7,7 +7,7 @@ module.exports = function collectInputsOutputs() {
if (doc.statics && doc.statics.length) { if (doc.statics && doc.statics.length) {
for (var i in doc.statics) { for (var i in doc.statics) {
// identify properties to differentiate from statics // identify properties to differentiate from methods
if (typeof doc.statics[i].parameters == 'undefined') { if (typeof doc.statics[i].parameters == 'undefined') {
doc.statics[i].isProperty = true; doc.statics[i].isProperty = true;
} }

15
scripts/docs/templates/common.template.html vendored
View File

@ -200,7 +200,9 @@ docType: "<$ doc.docType $>"
Delegate: <$ doc.delegate $> Delegate: <$ doc.delegate $>
</small> </small>
<@ endif @> <@ endif @>
<@- if doc.beta == true -@>
<span class="beta" title="beta">&beta;</span>
<@- endif -@>
</h1> </h1>
<a class="improve-v2-docs" href="http://github.com/driftyco/ionic-native/edit/master/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/') $>#L<$ doc.location.start.line $>"> <a class="improve-v2-docs" href="http://github.com/driftyco/ionic-native/edit/master/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/') $>#L<$ doc.location.start.line $>">
@ -213,6 +215,15 @@ docType: "<$ doc.docType $>"
<@- if doc.decorators @> <@- if doc.decorators @>
<@ for prop in doc.decorators[0].argumentInfo @> <@ for prop in doc.decorators[0].argumentInfo @>
<@ if doc.beta == true @>
<p class="beta-notice">
This plugin is still in beta stage and may not work as expected. Please
submit and issues to the <a target="_blank"
href="<$ prop.repo $>/issues">plugin repo</a>.
</p>
<@ endif @>
<pre><code>$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plugin $><@ endif -@></code></pre> <pre><code>$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plugin $><@ endif -@></code></pre>
<p>Repo: <p>Repo:
<a href="<$ prop.repo $>"> <a href="<$ prop.repo $>">
@ -244,7 +255,7 @@ docType: "<$ doc.docType $>"
<!-- @platforms tag end --> <!-- @platforms tag end -->
<@ endif @> <@ endif @>
<@ endfor @> <@ endfor @>
<@ endif -@> <@ endif -@><!-- if doc.decorators -->
<!-- @usage tag --> <!-- @usage tag -->
<@ if doc.usage @> <@ if doc.usage @>