docs(): add missing docs

This commit is contained in:
Ibby Hadeed
2016-08-11 07:55:26 -04:00
parent 2160a2d9e8
commit ecbe5faef8
5 changed files with 70 additions and 5 deletions
+15 -1
View File
@@ -7,6 +7,20 @@ import { Observable } from 'rxjs/Observable';
* @description
* Embedded httpd for Cordova apps. Light weight HTTP server.
* @usage
* ```typescript
* import {Httpd, HttpdOptions} from 'ionic-native';
*
* let options: HttpdOptions = {
* www_root: 'httpd_root', // relative path to app's www directory
* port: 80,
* localhost_only: false
* };
*
* Httpd.startServer(options).subscribe((data) => {
* console.log('Server is live');
* });
*
* ```
*/
@Plugin({
plugin: 'https://github.com/floatinghotpot/cordova-httpd.git',
@@ -25,7 +39,7 @@ export class Httpd {
observable: true,
clearFunction: 'stopServer'
})
static startServer(options: any): Observable<string> { return; }
static startServer(options?: any): Observable<string> { return; }
/**
* Gets the URL of the running server