modulefdoc_settings
The project settings: FORD's options, their defaults and their conversion from text.
Every source of settings (project file, fpm.toml, --config, command line) goes through
set_option, which takes the option's values as a list of strings, the form the project file
gives them.
Uses
Graphs
Uses
Used by
Variables
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
| INTEGER_OPTIONS | character(len=*) | privateparameter | 'graph_maxdepthgraph_maxnodesgraph_project_maxnodesmax_frontpage_itemsparallel' | |
| LIST_OPTIONS | character(len=*) | privateparameter | 'copy_subdirdisplayexcludeexclude_dirextensionsextra_vartypesfixed_extensionsfpp_extensions'//'html_template_dirincludemacromd_extensionssrc_dir' | |
| LOGICAL_OPTIONS | character(len=*) | privateparameter | 'coloured_edgesdbgdoxygenexternalizefixed_length_limitforcegraphhide_undocincl_srclowerpreprocess'//'print_creation_dateproc_internalsquietsearchshow_proc_parentsourcewarn' | |
| MAP_OPTIONS | character(len=*) | privateparameter | 'aliasexternalextra_modsextra_filetypes' | |
| PATH_LIST_OPTIONS | character(len=*) | privateparameter | 'copy_subdirexclude_dirhtml_template_dirincludesrc_dir' | |
| PATH_OPTIONS | character(len=*) | privateparameter | 'cssfavicongraph_dirlogomathjax_configmd_base_dirmedia_diroutput_dirpage_dir' | |
| STRING_OPTIONS | character(len=*) | privateparameter | 'authorauthor_descriptionauthor_picbitbucketcreation_datedoc_licensedocmarkdocmark_altemailencoding'//'facebookgithubgitlabgitter_sidecargoogle_pluslicenselinkedinpredocmarkpredocmark_altpreprocessor'//'privacy_policy_urlprojectproject_bitbucketproject_downloadproject_githubproject_gitlab'//'project_sourceforgeproject_urlproject_websiterevisionsortsummaryterms_of_service_urltwitterversion'//'websiteyear' |
Types
file_type_t
An extra_filetypes entry.
map_entry_t
A key and its value.
settings_t
The project settings. Optional text options are not allocated unless set.
Functions
dump_settings
The settings as a JSON object, for comparison with FORD's. Unset options are null.
in_setpureprivate
True if key is one of the blank-separated words of set, which starts and ends with a blank.
Subroutines
add_entryprivate
Set key in entries, replacing any entry it has.
add_intrinsic_modulesprivate
Add the modules that come with compilers and common libraries to extra_mods.
check_settings
Validate the project file's settings and derive what depends on them, before the command line is applied.
finish_settings
Make paths absolute and format dates, after all settings are applied.
set_mapprivate
Set a map option from strings of the form key<sep>value. Empty strings are ignored.
set_option
Set option key, which must be one (see is_option), from its values as text.