BasicDoclet

BasicDoclet

Object Hierarchy:

Description:

public abstract class BasicDoclet : Visitor, Doclet

Namespace: Valadoc.Html

Package: valadoc

Content:

Constants:

private const string css_basic_type
private const string css_box
private const string css_box_column
private const string css_box_content
private const string css_box_headline
private const string css_box_headline_text
private const string css_box_headline_toggle
private const string css_brief_description
private const string css_code_definition
private const string css_deprecated
private const string css_description
private const string css_diagram
private const string css_enum_table
private const string css_enum_table_name
private const string css_enum_table_text
private const string css_errordomain_table
private const string css_errordomain_table_name
private const string css_errordomain_table_text
private const string css_exception_table
private const string css_headline_hr
private const string css_hr
private const string css_inline_navigation
private const string css_keyword
private const string css_known_list
private const string css_leaf_brief_description
private const string css_leaf_code_definition
private const string css_list_cl
private const string css_list_del
private const string css_list_en
private const string css_list_errdom
private const string css_list_field
private const string css_list_iface
private const string css_list_m
private const string css_list_ns
private const string css_list_prop
private const string css_list_sig
private const string css_list_stru
private const string css_namespace_note
private const string css_navi
private const string css_navi_hr
private const string css_notification_area
private const string css_optional_parameter
private const string css_other_type
private const string css_package_index
private const string css_package_note
private const string css_parameter_table
private const string css_parameter_table_name
private const string css_parameter_table_text
private const string css_see_list
private const string css_site_header
private const string css_source_sample
private const string css_style_body
private const string css_style_content
private const string css_style_navigation
private const string css_title
private const string css_wiki_table

Properties:

public LinkHelper linker { get; protected set; }
public Settings settings { get; protected set; }
public string wiki_index_name { get; protected set; }

Creation methods:

protected BasicDoclet ()

Methods:

protected void fetch_subnamespace_names (Node node, ArrayList<Namespace> namespaces)
private inline ArrayList<Node> get_accessible_nodes_from_list (Collection<Node> nodes)
protected virtual string get_icon_directory ()
protected virtual string get_img_path (Node element, string type)
protected virtual string get_img_path_html (Node element, string type)
protected string? get_link (Node to, Node from)
private bool has_brief_description (Node element)
private inline bool has_visible_inheritable_children (TypeSymbol symbol)
protected bool is_internal_node (Node node)
public virtual void process (Settings settings, Tree tree, ErrorReporter reporter)
private TypeSymbol? unpack_type_reference (TypeReference? type_reference)
private void write_attributes (Symbol element, Node? pos)
private void write_brief_description (Node element, Node? pos)
protected void write_child_dependencies (Package package, Node? parent)
protected void write_child_namespaces (Node node, Node? parent)
protected void write_children (Node node, NodeType type, string type_string, Node? container)
private void write_documentation (Node element, Node? pos)
protected void write_file_footer ()
protected void write_file_header (string css, string js, string? title)
protected void write_image_block (Node element)
private void write_inherited_members_headline ()
private void write_inherited_symbols_note (TypeSymbol symbol, string type, Node container)
private void write_inherited_symbols_note_for_class (Class cl, Node container)
private void write_inherited_symbols_note_for_interface (Interface iface, Node container)
private void write_inherited_symbols_note_for_struct (Struct str, Node container)
private void write_known_symbols_note (Collection<Node> nodes2, Node container, string headline)
public void write_namespace_content (Namespace node, Node? parent)
protected void write_namespace_note (Node element)
protected void write_navi_children (Node node, NodeType type, Node? parent)
protected void write_navi_entry (Node element, Node? pos, string style, bool link, bool full_name = false)
protected void write_navi_entry_html_template (string style, string content, bool is_deprecated)
protected void write_navi_entry_html_template_with_link (string style, string link, string content, bool is_deprecated)
protected void write_navi_leaf_symbol (Node node)
protected void write_navi_package (Package package)
public void write_navi_packages (Tree tree)
public void write_navi_packages_inline (Tree tree)
protected void write_navi_symbol (Node node)
protected void write_navi_symbol_inline (Node node, Node? parent)
protected void write_navi_top_entry (Node element, Node? parent)
protected void write_package_content (Package node, Node? parent)
public void write_package_index_content (Tree tree)
protected void write_package_note (Node element)
private void write_signature (Node element, Node? pos)
public void write_symbol_content (Node node)
protected void write_top_element_template (string link)
protected void write_top_elements (Node element, Node? parent)
protected virtual void write_wiki_page (WikiPage page, string contentp, string css_path, string js_path, string pkg_name)
protected void write_wiki_pages (Tree tree, string css_path_wiki, string js_path_wiki, string contentp)

Fields:

private LinkHelper _linker
protected HtmlRenderer _renderer
private Settings _settings
private string _wiki_index_name
protected CssClassResolver cssresolver
private uint html_id_counter
protected Factory image_factory
private static NodeType[] inheritable_members
protected string package_list_link
protected ErrorReporter reporter
protected Tree tree
protected MarkupWriter writer

Inherited Members:

All known members inherited from class Valadoc.Api.Visitor

All known members inherited from class GLib.Object

All known members inherited from interface Valadoc.Doclet

process