modulefdoc_urls

Where entities are documented, and what [[name]] links refer to.

This runs while documentation is rendered in parallel, so nothing here calls a function returning a deferred-length string (see example/slen_race.f90).

Uses

Graphs

Uses

Used by

Types

link_context_t

Where a [[name]] link is being read.

Functions

find_anywhereprivate

integer function find_anywhere(list, name, entity) result(found)

The entity named name at the top level of the project, or 0.

find_childprivate

integer function find_child(list, parent, name, entity) result(found)

The child of parent named name, or 0.

is_shownpure

pure logical function is_shown(list, item)

True if item and everything that holds it are shown.

matchesprivate

logical function matches(list, id, name, entity)

True if entity id is named name, in lowercase, and is of class entity.

of_classpureprivate

pure logical function of_class(e, entity)

True if entity e is of class entity, as written in a link. Any entity matches ''.

top_levelelementalprivate

elemental logical function top_level(kind)

True if a link to kind can name it from anywhere in the project.

Subroutines

entity_anchor

subroutine entity_anchor(list, id, b)

Write the anchor of an entity in a page.

entity_urlrecursive

recursive subroutine entity_url(list, id, url)

The URL of an entity relative to the root of the site, or ''.

index_entity_names

subroutine index_entity_names(list)

Index the entities that links can name from anywhere, for find_anywhere.

object_word

subroutine object_word(e, word)

The word FORD uses for the kind of entity e.

page_name

subroutine page_name(name, out)

name as used in file names and anchors.

resolve_link

subroutine resolve_link(data, name, entity, child, child_entity, url, text, found)

Find what a [[name]] link means: see link_resolver in fdoc_markdown.

shown_entitypureprivate

pure subroutine shown_entity(list, item)

Replace item by what holds it, if it is inside something not shown, which has no page.

url_quote

subroutine url_quote(text, out)

Percent-encode the characters of text that are not safe in a URL.