Class Documenter

Hierarchy

Creator
- Documenter

Index

Constructors

constructor

Properties

init_parser verilog_parser vhdl_parser

Constructors

constructor

new Documenter(): Documenter
Returns Documenter
Overrides section_creator.Creator.constructor
- Defined in documenter/documenter.ts:40

Properties

`Private` init_parser

init_parser: boolean = false

`Private` verilog_parser

verilog_parser: any

`Private` vhdl_parser

vhdl_parser: any

Methods

`Private` create_parser

create_parser(lang: HDL_LANG): Promise<void>
Parameters
- lang: HDL_LANG
Returns Promise<void>
- Defined in documenter/documenter.ts:235

`Private` get_code_tree

get_code_tree(code: string, lang: HDL_LANG, configuration: t_documenter_options): Promise<any>
Parameters
- code: string
- lang: HDL_LANG
- configuration: t_documenter_options
Returns Promise<any>
- Defined in documenter/documenter.ts:206

get_custom_section

get_custom_section(position: string, hdl_element: Hdl_element, input_path: string, output_type: doc_output_type): string
Parameters
- position: string
- hdl_element: Hdl_element
- input_path: string
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_custom_section
- Defined in documenter/section_creator.ts:576

get_description

get_description(description: string, svg_path_dir: string, image_basename: string, output_type: doc_output_type): string
Parameters
- description: string
- svg_path_dir: string
- image_basename: string
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_description
- Defined in documenter/section_creator.ts:118

get_description_section

get_description_section(hdl_element: Hdl_element, configuration: t_documenter_options, svg_path_dir: string, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- svg_path_dir: string
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_description_section
- Defined in documenter/section_creator.ts:103

get_diagram_section

get_diagram_section(hdl_element: Hdl_element, configuration: t_documenter_options, dir_svg: string, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- dir_svg: string
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_diagram_section
- Defined in documenter/section_creator.ts:237

get_diagram_svg_from_code_tree

get_diagram_svg_from_code_tree(hdl_element: Hdl_element): string
Parameters
- hdl_element: Hdl_element
Returns string
Inherited from section_creator.Creator.get_diagram_svg_from_code_tree
- Defined in documenter/section_creator.ts:266

get_doc_constants

get_doc_constants(constants: Constant_hdl[], translator: Translator): string
Parameters
- constants: Constant_hdl[]
- translator: Translator
Returns string
Inherited from section_creator.Creator.get_doc_constants
- Defined in documenter/section_creator.ts:720

get_doc_generics

get_doc_generics(generics: Port_hdl[], translator: Translator): string
Parameters
- generics: Port_hdl[]
- translator: Translator
Returns string
Inherited from section_creator.Creator.get_doc_generics
- Defined in documenter/section_creator.ts:679

get_doc_ports

get_doc_ports(ports: Port_hdl[], v_bus_list: Virtual_bus_hdl[], translator: Translator): string
Parameters
- ports: Port_hdl[]
- v_bus_list: Virtual_bus_hdl[]
- translator: Translator
Returns string
Inherited from section_creator.Creator.get_doc_ports
- Defined in documenter/section_creator.ts:633

get_doc_signals

get_doc_signals(signals: Signal_hdl[], translator: Translator): string
Parameters
- signals: Signal_hdl[]
- translator: Translator
Returns string
Inherited from section_creator.Creator.get_doc_signals
- Defined in documenter/section_creator.ts:700

get_doc_types

get_doc_types(tpyes: Type_hdl[], translator: Translator): string
Parameters
- tpyes: Type_hdl[]
- translator: Translator
Returns string
Inherited from section_creator.Creator.get_doc_types
- Defined in documenter/section_creator.ts:745

get_document

get_document(code: string, lang: HDL_LANG, configuration: t_documenter_options, save: boolean, input_path: string, output_svg_dir: string, extra_top_space: boolean, output_type: doc_output_type): Promise<result_type>
Parameters
- code: string
- lang: HDL_LANG
- configuration: t_documenter_options
- save: boolean
- input_path: string
- output_svg_dir: string
- extra_top_space: boolean
- output_type: doc_output_type
Returns Promise<result_type>
- Defined in documenter/documenter.ts:85

get_elements_with_description

get_elements_with_description(elements: any): any[]
Parameters
- elements: any
Returns any[]
Inherited from section_creator.Creator.get_elements_with_description
- Defined in documenter/section_creator.ts:46

get_fsm

get_fsm(code: string, lang: HDL_LANG, configuration: t_documenter_options): Promise<any>
Parameters
- code: string
- lang: HDL_LANG
- configuration: t_documenter_options
Returns Promise<any>
- Defined in documenter/documenter.ts:245

get_fsm_section

get_fsm_section(fsm_list: any, hdl_element: Hdl_element, configuration: t_documenter_options, svg_output_dir: string, output_type: doc_output_type): string
Parameters
- fsm_list: any
- hdl_element: Hdl_element
- configuration: t_documenter_options
- svg_output_dir: string
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_fsm_section
- Defined in documenter/section_creator.ts:528

`Private` get_fsm_svg

get_fsm_svg(code: string, lang: HDL_LANG, configuration: t_documenter_options): Promise<any>
Parameters
- code: string
- lang: HDL_LANG
- configuration: t_documenter_options
Returns Promise<any>
- Defined in documenter/documenter.ts:255

get_function_section

get_function_section(hdl_element: Hdl_element, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_function_section
- Defined in documenter/section_creator.ts:432

get_in_out_section

get_in_out_section(hdl_element: Hdl_element, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_in_out_section
- Defined in documenter/section_creator.ts:295

get_info_section

get_info_section(hdl_element: Hdl_element, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_info_section
- Defined in documenter/section_creator.ts:276

get_input_section

get_input_section(input_path: string, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- input_path: string
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_input_section
- Defined in documenter/section_creator.ts:89

get_instantiation_section

get_instantiation_section(hdl_element: Hdl_element, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_instantiation_section
- Defined in documenter/section_creator.ts:490

get_interface

get_interface(interface_inst: Hdl_element, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- interface_inst: Hdl_element
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_interface
- Defined in documenter/section_creator_interface.ts:46

get_interface_section

get_interface_section(hdl_element: Hdl_element, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_interface_section
- Defined in documenter/section_creator_interface.ts:31

get_json_candidates

get_json_candidates(text: string): any
Parameters
- text: string
Returns any
Inherited from section_creator.Creator.get_json_candidates
- Defined in documenter/section_creator.ts:200

get_logics

get_logics(items: Logic_hdl[], translator: Translator, output_type: doc_output_type): string
Parameters
- items: Logic_hdl[]
- translator: Translator
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_logics
- Defined in documenter/section_creator_interface.ts:140

get_modports

get_modports(modports: Modport_hdl[], translator: Translator, output_type: doc_output_type): string
Parameters
- modports: Modport_hdl[]
- translator: Translator
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_modports
- Defined in documenter/section_creator_interface.ts:169

get_others

get_others(items: any, translator: Translator, output_type: doc_output_type): string
Parameters
- items: any
- translator: Translator
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_others
- Defined in documenter/section_creator_interface.ts:155

get_parameters_interface

get_parameters_interface(items: Port_hdl[], translator: Translator, output_type: doc_output_type): string
Parameters
- items: Port_hdl[]
- translator: Translator
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_parameters_interface
- Defined in documenter/section_creator_interface.ts:93

`Private` get_parser

get_parser(lang: HDL_LANG): Promise<any>
Parameters
- lang: HDL_LANG
Returns Promise<any>
- Defined in documenter/documenter.ts:222

get_ports_interface

get_ports_interface(items: Port_hdl[], translator: Translator, output_type: doc_output_type): string
Parameters
- items: Port_hdl[]
- translator: Translator
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_ports_interface
- Defined in documenter/section_creator_interface.ts:108

get_process_section

get_process_section(hdl_element: Hdl_element, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_process_section
- Defined in documenter/section_creator.ts:384

get_signal_constant_section

get_signal_constant_section(hdl_element: Hdl_element, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_signal_constant_section
- Defined in documenter/section_creator.ts:339

get_title_section

get_title_section(hdl_element: Hdl_element, configuration: t_documenter_options, output_type: doc_output_type): string
Parameters
- hdl_element: Hdl_element
- configuration: t_documenter_options
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_title_section
- Defined in documenter/section_creator.ts:72

get_types_data_interface

get_types_data_interface(items: any, translator: Translator, output_type: doc_output_type): string
Parameters
- items: any
- translator: Translator
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.get_types_data_interface
- Defined in documenter/section_creator_interface.ts:125

get_wavedrom_svg

get_wavedrom_svg(description: string): {
description: string;
wavedrom: any[];
}
Parameters
- description: string
Returns {
description: string;
wavedrom: any[];
}
- description: string
- wavedrom: any[]
Inherited from section_creator.Creator.get_wavedrom_svg
- Defined in documenter/section_creator.ts:159

`Private` init

init(): Promise<void>
Returns Promise<void>
- Defined in documenter/documenter.ts:216

parse_wavedrom

parse_wavedrom(description: string, svg_path_dir: string, svg_prefix_name: string, output_type: doc_output_type): string
Parameters
- description: string
- svg_path_dir: string
- svg_prefix_name: string
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.parse_wavedrom
- Defined in documenter/section_creator.ts:130

remove_break_line

remove_break_line(description: string): string
Parameters
- description: string
Returns string
Inherited from section_creator.Creator.remove_break_line
- Defined in documenter/section_creator.ts:57

save_document

save_document(code: string, lang: HDL_LANG, configuration: t_documenter_options, input_path: string, output_path: string, output_type: doc_output_type): Promise<boolean>
Parameters
- code: string
- lang: HDL_LANG
- configuration: t_documenter_options
- input_path: string
- output_path: string
- output_type: doc_output_type
Returns Promise<boolean>
- Defined in documenter/documenter.ts:47

save_fsm

save_fsm(fsm_list: any, hdl_element: Hdl_element, svg_output_dir: string): void
Parameters
- fsm_list: any
- hdl_element: Hdl_element
- svg_output_dir: string
Returns void
Inherited from section_creator.Creator.save_fsm
- Defined in documenter/section_creator.ts:566

save_svg

save_svg(code: string, lang: HDL_LANG, configuration: t_documenter_options, path: string): Promise<boolean>
Parameters
- code: string
- lang: HDL_LANG
- configuration: t_documenter_options
- path: string
Returns Promise<boolean>
- Defined in documenter/documenter.ts:65

save_svg_from_code_tree

save_svg_from_code_tree(hdl_element: Hdl_element, path_svg: string): void
Parameters
- hdl_element: Hdl_element
- path_svg: string
Returns void
Inherited from section_creator.Creator.save_svg_from_code_tree
- Defined in documenter/section_creator.ts:261

transform

transform(markdown_str: string, output_type: doc_output_type): string
Parameters
- markdown_str: string
- output_type: doc_output_type
Returns string
Inherited from section_creator.Creator.transform
- Defined in documenter/section_creator.ts:61

Class Documenter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Documenter

Properties

Private init_parser

Private verilog_parser

Private vhdl_parser

Methods

Private create_parser

Parameters

lang: HDL_LANG

Returns Promise<void>

Private get_code_tree

Parameters

code: string

lang: HDL_LANG

configuration: t_documenter_options

Returns Promise<any>

get_custom_section

Parameters

position: string

hdl_element: Hdl_element

input_path: string

output_type: doc_output_type

Returns string

get_description

Parameters

description: string

svg_path_dir: string

image_basename: string

output_type: doc_output_type

Returns string

get_description_section

Parameters

hdl_element: Hdl_element

configuration: t_documenter_options

svg_path_dir: string

output_type: doc_output_type

Returns string

get_diagram_section

Parameters

hdl_element: Hdl_element

configuration: t_documenter_options

dir_svg: string

output_type: doc_output_type

Returns string

get_diagram_svg_from_code_tree

Parameters

hdl_element: Hdl_element

Returns string

get_doc_constants

Parameters

constants: Constant_hdl[]

translator: Translator

Returns string

get_doc_generics

Parameters

generics: Port_hdl[]

translator: Translator

Returns string

get_doc_ports

Parameters

ports: Port_hdl[]

v_bus_list: Virtual_bus_hdl[]

translator: Translator

Returns string

get_doc_signals

Parameters

signals: Signal_hdl[]

translator: Translator

Returns string

get_doc_types

Parameters

tpyes: Type_hdl[]

`Private` init_parser

`Private` verilog_parser

`Private` vhdl_parser

`Private` create_parser

`Private` get_code_tree

`Private` get_fsm_svg