| namespace | bhenk\doc2rst\globals |
| predicates | Final | Enum |
| implements | UnitEnum |
Holds property names for configuration of Container :ref:`bhenk\doc2rst\globals\RunConfiguration`
The names of cases in this enum correspond to keys in the :term:`d2r-conf.php` configuration file, found in your { :ref:`doc_root <\bhenk\doc2rst\globals\RC::doc_root>` } directory after running ProcessManager::quickStart().
Contents
- Constants
- RC::application_root
- RC::vendor_directory
- RC::bootstrap_file
- RC::doc_root
- RC::api_directory
- RC::api_docs_title
- RC::show_visibility
- RC::excludes
- RC::log_level
- RC::toctree_max_depth
- RC::toctree_titles_only
- RC::show_class_contents
- RC::user_provided_links
- RC::link_to_sources
- RC::link_to_search_engine
- RC::download_file_ext
- RC::show_datestamp
- Methods
| predicates | public | enum case |
The source directory, usually indicated with names like src or application
(string)
For autoconfiguration:
project_directory/application_root
enum(bhenk\doc2rst\globals\RC::application_root)| predicates | public | enum case |
The vendor directory or first part of namespace
(string)
For autoconfiguration:
project_directory/application_root/vendor_directory
enum(bhenk\doc2rst\globals\RC::vendor_directory)| predicates | public | enum case |
Location of the bootstrap file
(string)
The file that locates your classes and third party classes used by your program. When using composer can be as simple as
<?php require_once "path/to/your/vendor/autoload.php";
enum(bhenk\doc2rst\globals\RC::bootstrap_file)| predicates | public | enum case |
The documentation directory; autoconfiguration is computed from this directory
(string)
For autoconfiguration:
project_directory/doc_root
enum(bhenk\doc2rst\globals\RC::doc_root)| predicates | public | enum case |
The directory for api-documentation
(string)
For autoconfiguration:
project_directory/doc_root/api_directory
enum(bhenk\doc2rst\globals\RC::api_directory)| predicates | public | enum case |
Title of the root entry in the generated api-documentation
(string)
enum(bhenk\doc2rst\globals\RC::api_docs_title)| predicates | public | enum case |
Specify which members will be documented
(int)
The integer corresponds to -and can be expressed as- the constants for visibility found in ReflectionMethod Modifiers:
- ReflectionMethod::IS_PUBLIC (1)
- ReflectionMethod::IS_PROTECTED (2)
- ReflectionMethod::IS_PRIVATE (4)
- ReflectionMethod::IS_STATIC (16)
- ReflectionMethod::IS_FINAL (32)
- ReflectionMethod::IS_ABSTRACT (64)
Hint
The values of these constants may change between PHP versions. It is recommended to always use the constants and not rely on the values directly.
It is perfectly alright to run doc2rst with show_visibility set to any possible number, though doc2rst may not be able to resolve all internal links (because some targets are absent after running with such visibility limitations). Best practice for communicating your library remains to document public and protected members.
show_visibility = ReflectionMethod::IS_PUBLIC | ReflectionMethod::IS_PROTECTED
enum(bhenk\doc2rst\globals\RC::show_visibility)| predicates | public | enum case |
Array of (parts of) namespaces and classes to exclude from documentation
(array)
To exclude complete branches, it is enough to exclude the root of that branch. To exclude individual classes, the fully qualified name of the class should be given
enum(bhenk\doc2rst\globals\RC::excludes)| predicates | public | enum case |
Level of logging during generation of documentation
(int)
Log level expressed as int, interval 100:
error always, warning <= 400, notice <= 300, info <= 200, debug <= 100
enum(bhenk\doc2rst\globals\RC::log_level)| predicates | public | enum case |
Max depth for the toctree directive
(int)
see also
enum(bhenk\doc2rst\globals\RC::toctree_max_depth)| predicates | public | enum case |
Only document titles should show up in the toctree, not other headings
(bool)
see also
enum(bhenk\doc2rst\globals\RC::toctree_titles_only)| predicates | public | enum case |
Should a table of contents appear at the top of the class documentation
(bool)
enum(bhenk\doc2rst\globals\RC::show_class_contents)| predicates | public | enum case |
User provided mapping of `namespace\classname` to links that give access to documentation on these types
Classes in external libraries cannot be linked to their documentation automatically.
(array)
enum(bhenk\doc2rst\globals\RC::user_provided_links)| predicates | public | enum case |
If no documentation of `namespace\classname` can be found, should a link to the (local) source file be provided
Classes in external libraries can be linked to their local source files.
(bool)
enum(bhenk\doc2rst\globals\RC::link_to_sources)| predicates | public | enum case |
If no documentation on `namespace\classname` can be found, should a link to a search engine be provided
(bool)
The search engine url will have the namespace\classname in the query parameter.
enum(bhenk\doc2rst\globals\RC::link_to_search_engine)| predicates | public | enum case |
Downloadable file extension list
(array)
If files with these extensions are found in the source tree, they will be made downloadable from the :term:`package documentation page` under the heading downloads.
Hint
It is also possible to add individual files to the downloads section of the package documentation page.
enum(bhenk\doc2rst\globals\RC::download_file_ext)| predicates | public | enum case |
Prevent or allow datestamp
(bool)
Each page in the generated documentation gets a datestamp at the foot of the page. It shows when the rst-file (not the html-file) was generated. This can be a nuisance during development and the use of VCR's. Each time you generate documentation the datestamp will differ and consequently your VCR sees that as changes in the file and wants you to commit the changes. In order to prevent this set show_datestamp to false.
enum(bhenk\doc2rst\globals\RC::show_datestamp)| predicates | public | static |
Gets the enum case for the given name or null if it doesn't exist
public static function forName(
Parameter #0 [ <required> string $name ]
): ?RC| predicates | public | static |
| implements | UnitEnum::cases |
public static function cases(): arrayFri, 31 Mar 2023 13:22:46 +0000