mirror of
https://codeberg.org/streams/streams.git
synced 2024-09-19 23:35:12 +00:00
revive doxygen documentation
This commit is contained in:
parent
e3e1404c77
commit
f3731c5f8d
6 changed files with 37 additions and 6 deletions
|
@ -3,7 +3,6 @@
|
||||||
namespace Code\Lib;
|
namespace Code\Lib;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file include/account.php
|
|
||||||
* @brief Some account related functions.
|
* @brief Some account related functions.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,6 @@ use Code\Render\Theme;
|
||||||
use Code\Lib\Url;
|
use Code\Lib\Url;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file connedit.php
|
|
||||||
* @brief In this file the connection-editor form is generated and evaluated.
|
* @brief In this file the connection-editor form is generated and evaluated.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -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()
|
* @see \Code\Photo\PhotoDriver::getImage()
|
||||||
*
|
*
|
||||||
|
|
|
@ -2,11 +2,11 @@ INPUT = README.md index.php boot.php include/ install/ util/ view/ Code/
|
||||||
RECURSIVE = YES
|
RECURSIVE = YES
|
||||||
PROJECT_NAME = "Streams"
|
PROJECT_NAME = "Streams"
|
||||||
PROJECT_LOGO = images/streams-64.png
|
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*
|
EXCLUDE_PATTERNS = *smarty3* *strings.php *.out *test*
|
||||||
OUTPUT_DIRECTORY = doc
|
OUTPUT_DIRECTORY = ./
|
||||||
GENERATE_HTML = YES
|
GENERATE_HTML = YES
|
||||||
HTML_OUTPUT = html/
|
HTML_OUTPUT = streams/
|
||||||
HTML_FILE_EXTENSION = .html
|
HTML_FILE_EXTENSION = .html
|
||||||
GENERATE_LATEX = NO
|
GENERATE_LATEX = NO
|
||||||
EXTRACT_ALL = YES
|
EXTRACT_ALL = YES
|
||||||
|
|
6
util/doxygen
Executable file
6
util/doxygen
Executable file
|
@ -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
|
27
util/pconfig.md
Normal file
27
util/pconfig.md
Normal file
|
@ -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
|
||||||
|
|
Loading…
Reference in a new issue