fdoc

typesettings_t

The project settings. Optional text options are not allocated unless set.

Components

NameTypeAttributesDefaultDescription
aliastype(map_entry_t)allocatabledimension(:)
authorcharacter(len=:)allocatable
author_descriptioncharacter(len=:)allocatable
author_piccharacter(len=:)allocatable
bitbucketcharacter(len=:)allocatable
coloured_edgeslogical.false.
copy_subdirtype(string_t)allocatabledimension(:)
creation_datecharacter(len=:)allocatable
csscharacter(len=:)allocatable
dbglogical.true.
directorycharacter(len=:)allocatable

the project's directory

displaytype(string_t)allocatabledimension(:)
doc_licensecharacter(len=:)allocatable
docmarkcharacter(len=:)allocatable
docmark_altcharacter(len=:)allocatable
doxygenlogical.true.
emailcharacter(len=:)allocatable
encodingcharacter(len=:)allocatable
excludetype(string_t)allocatabledimension(:)
exclude_dirtype(string_t)allocatabledimension(:)
extensionstype(string_t)allocatabledimension(:)
externaltype(map_entry_t)allocatabledimension(:)
externalizelogical.true.
extra_filetypestype(file_type_t)allocatabledimension(:)
extra_modstype(map_entry_t)allocatabledimension(:)
extra_vartypestype(string_t)allocatabledimension(:)
facebookcharacter(len=:)allocatable
faviconcharacter(len=:)allocatable
fixed_extensionstype(string_t)allocatabledimension(:)
fixed_length_limitlogical.true.
forcelogical.false.
fpp_extensionstype(string_t)allocatabledimension(:)
githubcharacter(len=:)allocatable
gitlabcharacter(len=:)allocatable
gitter_sidecarcharacter(len=:)allocatable
google_pluscharacter(len=:)allocatable
graphlogical.false.
graph_dircharacter(len=:)allocatable
graph_maxdepthinteger10000
graph_maxnodesinteger1000000000
graph_project_maxnodesintegerhuge(1)
hide_undoclogical.false.
html_template_dirtype(string_t)allocatabledimension(:)
incl_srclogical.true.
includetype(string_t)allocatabledimension(:)
licensecharacter(len=:)allocatable
linkedincharacter(len=:)allocatable
lowerlogical.false.
macrotype(string_t)allocatabledimension(:)
mathjax_configcharacter(len=:)allocatable
max_frontpage_itemsinteger10
md_base_dircharacter(len=:)allocatable
md_extensionstype(string_t)allocatabledimension(:)
media_dircharacter(len=:)allocatable
output_dircharacter(len=:)allocatable
page_dircharacter(len=:)allocatable
parallelinteger1

threads to use: new_settings gives every core

predocmarkcharacter(len=:)allocatable
predocmark_altcharacter(len=:)allocatable
preprocesslogical.true.
preprocessorcharacter(len=:)allocatable
print_creation_datelogical.false.
privacy_policy_urlcharacter(len=:)allocatable
proc_internalslogical.false.
projectcharacter(len=:)allocatable
project_bitbucketcharacter(len=:)allocatable
project_downloadcharacter(len=:)allocatable
project_githubcharacter(len=:)allocatable
project_gitlabcharacter(len=:)allocatable
project_sourceforgecharacter(len=:)allocatable
project_urlcharacter(len=:)allocatable
project_websitecharacter(len=:)allocatable
quietlogical.false.
relativelogical.true.

true if project_url was not given

revisioncharacter(len=:)allocatable
show_proc_parentlogical.false.
sortcharacter(len=:)allocatable
sourcelogical.false.
src_dirtype(string_t)allocatabledimension(:)
summarycharacter(len=:)allocatable
terms_of_service_urlcharacter(len=:)allocatable
twittercharacter(len=:)allocatable
versioncharacter(len=:)allocatable
warnlogical.false.
websitecharacter(len=:)allocatable
yearcharacter(len=:)allocatable

Source

Show the code
type, public :: settings_t
    !! The project settings. Optional text options are not allocated unless set.
    character(len=:), allocatable :: author, author_description, author_pic, bitbucket, doc_license, email, facebook
    character(len=:), allocatable :: github, gitlab, gitter_sidecar, google_plus, license, linkedin, privacy_policy_url
    character(len=:), allocatable :: project_bitbucket, project_download, project_github, project_gitlab
    character(len=:), allocatable :: project_sourceforge, project_website, revision, summary, terms_of_service_url
    character(len=:), allocatable :: twitter, version, website
    character(len=:), allocatable :: creation_date, docmark, docmark_alt, encoding, predocmark, predocmark_alt
    character(len=:), allocatable :: preprocessor, project, project_url, sort, year
    character(len=:), allocatable :: css, favicon, graph_dir, logo, mathjax_config, md_base_dir, media_dir, output_dir, page_dir
    character(len=:), allocatable :: directory          !! the project's directory
    logical :: coloured_edges = .false., dbg = .true., doxygen = .true., externalize = .true.
    logical :: fixed_length_limit = .true., force = .false., graph = .false., hide_undoc = .false., incl_src = .true.
    logical :: lower = .false., preprocess = .true., print_creation_date = .false., proc_internals = .false.
    logical :: quiet = .false., search = .true., show_proc_parent = .false., source = .false., warn = .false.
    logical :: relative = .true.                        !! true if `project_url` was not given
    integer :: graph_maxdepth = 10000, graph_maxnodes = 1000000000, graph_project_maxnodes = huge(1)
    integer :: max_frontpage_items = 10
    integer :: parallel = 1                             !! threads to use: `new_settings` gives every core
    type(string_t), allocatable :: copy_subdir(:), display(:), exclude(:), exclude_dir(:), extensions(:)
    type(string_t), allocatable :: extra_vartypes(:), fixed_extensions(:), fpp_extensions(:), html_template_dir(:)
    type(string_t), allocatable :: include(:), macro(:), md_extensions(:), src_dir(:)
    type(map_entry_t), allocatable :: alias(:), external(:), extra_mods(:)
    type(file_type_t), allocatable :: extra_filetypes(:)
end type settings_t

Graphs

Inherits

settings_tmap_entry_talias, external, extra_modsfile_type_textra_filetypes

Inherited by