mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-02-22 01:19:36 +08:00
docs(): update docs formatting
This commit is contained in:
parent
6f7171d26b
commit
54ef50178b
10
scripts/docs/templates/common.template.html
vendored
10
scripts/docs/templates/common.template.html
vendored
@ -30,7 +30,7 @@ docType: "<$ doc.docType $>"
|
|||||||
<@ if param.optional @><div><em>(optional)</em></div><@ endif @>
|
<@ if param.optional @><div><em>(optional)</em></div><@ endif @>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<$ param.returnType | escape $>
|
<code><$ param.returnType | escape $></code>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<$ param.description | marked $>
|
<$ param.description | marked $>
|
||||||
@ -308,13 +308,13 @@ docType: "<$ doc.docType $>"
|
|||||||
<!-- other classes -->
|
<!-- other classes -->
|
||||||
<@ for tag in doc.tags.tags -@>
|
<@ for tag in doc.tags.tags -@>
|
||||||
<@ if tag.tagName == 'classes' -@>
|
<@ if tag.tagName == 'classes' -@>
|
||||||
<h2><a class="anchor" name="related-classes" href="#related-classes"></a>Related Classes</h2>
|
<!--<h2><a class="anchor" name="related-classes" href="#related-classes"></a>Related Classes</h2>-->
|
||||||
<@ set classes = tag.description.split('\n') @>
|
<@ set classes = tag.description.split('\n') @>
|
||||||
<@ for item in classes -@>
|
<@ for item in classes -@>
|
||||||
<@ if item.length > 1 @>
|
<@ if item.length > 1 @>
|
||||||
<@ for export in doc.moduleDoc.exports -@>
|
<@ for export in doc.moduleDoc.exports -@>
|
||||||
<@ if export.name == item @>
|
<@ if export.name == item @>
|
||||||
<h3><a class="anchor" name="<$ item $>" href="#<$ item $>"></a><$ item $></h3>
|
<h2><a class="anchor" name="<$ item $>" href="#<$ item $>"></a><$ item $></h2>
|
||||||
<$ documentClass(export) $>
|
<$ documentClass(export) $>
|
||||||
<@ endif @>
|
<@ endif @>
|
||||||
<@- endfor @>
|
<@- endfor @>
|
||||||
@ -327,11 +327,11 @@ docType: "<$ doc.docType $>"
|
|||||||
<!-- interfaces -->
|
<!-- interfaces -->
|
||||||
<@ for tag in doc.tags.tags -@>
|
<@ for tag in doc.tags.tags -@>
|
||||||
<@ if tag.tagName == 'interfaces' @>
|
<@ if tag.tagName == 'interfaces' @>
|
||||||
<h2><a class="anchor" name="interfaces" href="#interfaces"></a>Interfaces</h2>
|
<!--<h2><a class="anchor" name="interfaces" href="#interfaces"></a>Interfaces</h2>-->
|
||||||
<@ set interfaces = tag.description.split('\n') @>
|
<@ set interfaces = tag.description.split('\n') @>
|
||||||
<@ for item in interfaces -@>
|
<@ for item in interfaces -@>
|
||||||
<@ if item.length > 1 @>
|
<@ if item.length > 1 @>
|
||||||
<h3><a class="anchor" name="<$ item $>" href="#<$ item $>"></a><$ item $></h3>
|
<h2><a class="anchor" name="<$ item $>" href="#<$ item $>"></a><$ item $></h2>
|
||||||
<$ interfaceTable(item) $>
|
<$ interfaceTable(item) $>
|
||||||
<@ endif @>
|
<@ endif @>
|
||||||
<@- endfor @>
|
<@- endfor @>
|
||||||
|
@ -260,10 +260,12 @@ export class ContactFindOptions implements IContactFindOptions {
|
|||||||
* ```
|
* ```
|
||||||
* @interfaces
|
* @interfaces
|
||||||
* IContactProperties
|
* IContactProperties
|
||||||
* @classes
|
* IContactError
|
||||||
* ContactFindOptions
|
* IContactName
|
||||||
* ContactOrganization
|
* IContactField
|
||||||
* ContactAddress
|
* IContactAddress
|
||||||
|
* IContactOrganization
|
||||||
|
* IContactFindOptions
|
||||||
*/
|
*/
|
||||||
@Plugin({
|
@Plugin({
|
||||||
pluginName: 'Contacts',
|
pluginName: 'Contacts',
|
||||||
|
@ -33,9 +33,8 @@ export class Httpd {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Starts a web server.
|
* Starts a web server.
|
||||||
* @returns {Observable<string>} Returns an Observable. Subscribe to receive the URL for your web server (if succeeded). Unsubscribe to stop the server.
|
|
||||||
* @param options {HttpdOptions}
|
* @param options {HttpdOptions}
|
||||||
* @returns {Observable<string>}
|
* @returns {Observable<string>} Returns an Observable. Subscribe to receive the URL for your web server (if succeeded). Unsubscribe to stop the server.
|
||||||
*/
|
*/
|
||||||
@Cordova({
|
@Cordova({
|
||||||
observable: true,
|
observable: true,
|
||||||
|
Loading…
Reference in New Issue
Block a user