diff --git a/Code/Lib/Account.php b/Code/Lib/Account.php index ce58e24d1..ee69ff308 100644 --- a/Code/Lib/Account.php +++ b/Code/Lib/Account.php @@ -3,7 +3,6 @@ namespace Code\Lib; /** - * @file include/account.php * @brief Some account related functions. */ diff --git a/Code/Module/Connedit.php b/Code/Module/Connedit.php index bb5dd3f4b..df05839e2 100644 --- a/Code/Module/Connedit.php +++ b/Code/Module/Connedit.php @@ -24,7 +24,6 @@ use Code\Render\Theme; use Code\Lib\Url; /** - * @file connedit.php * @brief In this file the connection-editor form is generated and evaluated. */ diff --git a/Code/Photo/PhotoImagick.php b/Code/Photo/PhotoImagick.php index 608c7b316..490feec7d 100644 --- a/Code/Photo/PhotoImagick.php +++ b/Code/Photo/PhotoImagick.php @@ -132,7 +132,7 @@ class PhotoImagick extends PhotoDriver /** - * @brief Return a \Imagick object of the current image. + * @brief Return an Imagick object from the current image. * * @see \Code\Photo\PhotoDriver::getImage() * diff --git a/util/Doxyfile b/util/Doxyfile index 7e82980ae..74fd9984d 100644 --- a/util/Doxyfile +++ b/util/Doxyfile @@ -2,11 +2,11 @@ INPUT = README.md index.php boot.php include/ install/ util/ view/ Code/ RECURSIVE = YES PROJECT_NAME = "Streams" PROJECT_LOGO = images/streams-64.png -EXCLUDE = .htconfig.php library/ doc/ store/ vendor/ .git/ util/generate-hooks-index/ +EXCLUDE = .htconfig.php cache/ library/ doc/ store/ vendor/ .git/ util/generate-hooks-index/ EXCLUDE_PATTERNS = *smarty3* *strings.php *.out *test* -OUTPUT_DIRECTORY = doc +OUTPUT_DIRECTORY = ./ GENERATE_HTML = YES -HTML_OUTPUT = html/ +HTML_OUTPUT = streams/ HTML_FILE_EXTENSION = .html GENERATE_LATEX = NO EXTRACT_ALL = YES diff --git a/util/doxygen b/util/doxygen new file mode 100755 index 000000000..56422c869 --- /dev/null +++ b/util/doxygen @@ -0,0 +1,6 @@ +#!/usr/bin/env bash +# generates doxygen source code documentatiin + + doxygen util/Doxyfile + echo open the following link in your browser + echo file://`pwd`/streams/index.html diff --git a/util/pconfig.md b/util/pconfig.md new file mode 100644 index 000000000..83d7dfe46 --- /dev/null +++ b/util/pconfig.md @@ -0,0 +1,27 @@ +CLI pconfig utility +================== + +Usage: + + +pconfig + displays all available channels and their ids + +pconfig {{uid}} + displays all pconfig entries for {{uid}} + +pconfig {{uid}} family + displays all pconfig entries for family (system, database, etc) + +pconfig {{uid}} family key + displays single pconfig entry for specified family and key + +pconfig {{uid}} family key value + set pconfig entry for specified family and key to value and display result + +NOTES: + family and key may be entered in dot notation, example: + pconfig 14 system.activitypub_enabled + is the same as + pconfig 14 system activitypub_enabled +