Procházet zdrojové kódy

generate code docs for private interfaces, too

El RIDO před 7 roky
rodič
revize
30bb34a4fe
1 změnil soubory, kde provedl 2 přidání a 2 odebrání
  1. 2 2
      doc/README.md

+ 2 - 2
doc/README.md

@@ -20,7 +20,7 @@ $ sudo pear install phpdoc/phpDocumentor
 To generate the documentation, change into the main directory and run phpdoc:
 To generate the documentation, change into the main directory and run phpdoc:
 ```console
 ```console
 $ cd PrivateBin
 $ cd PrivateBin
-$ phpdoc -t doc/phpdoc -d lib/
+$ phpdoc --visibility public,protected,private -t doc/phpdoc -d lib/
 ```
 ```
 
 
 **Note:** When used with PHP 7, the prerelease of phpDocumentator 2.9 needs to be
 **Note:** When used with PHP 7, the prerelease of phpDocumentator 2.9 needs to be
@@ -55,6 +55,6 @@ $ ln -s /usr/bin/nodejs /usr/local/bin/node
 To generate the documentation, change into the main directory and run phpdoc:
 To generate the documentation, change into the main directory and run phpdoc:
 ```console
 ```console
 $ cd PrivateBin
 $ cd PrivateBin
-$ jsdoc -d doc/jsdoc js/privatebin.js
+$ jsdoc -p -d doc/jsdoc js/privatebin.js
 ```
 ```