Eiffeldoc: EIFFELDOC_CONTEXT

+

Point of view

All features

class EIFFELDOC_CONTEXT

Summary

Shared context for all Eiffeldoc classes.

Direct parents: Insert list: ANY

Overview

Creation features

make

Features

set_options (a_options: EIFFELDOC_OPTIONS)

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC}

set_class_text (a_class_text: CLASS_TEXT)
set_html (a_html: EIFFELDOC_OUTPUT_STREAM)
set_type (a_type: TYPE)

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC, EIFFELDOC_COMMENT_STATE, EIFFELDOC_CORE, EIFFELDOC_SHORTER, EIFFELDOC_COMMENT_WRITER}

type: TYPE
html: EIFFELDOC_OUTPUT_STREAM
class_type: TYPE
class_text: CLASS_TEXT
options: EIFFELDOC_OPTIONS
write_comment (comment: COMMENT, from_sentence: INTEGER_32, to_sentence: INTEGER_32)
write_feature_comment (a_comment: COMMENT, for_feature: ANONYMOUS_FEATURE, from_sentence: INTEGER_32, to_sentence: INTEGER_32)

{EIFFELDOC_COMMENT_WRITER}

{}

set_options (a_options: EIFFELDOC_OPTIONS)

effective procedure

require

a_options /= Void

set_class_text (a_class_text: CLASS_TEXT)

effective procedure

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC}

require

a_class_text /= Void

set_html (a_html: EIFFELDOC_OUTPUT_STREAM)

effective procedure

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC}

require

a_html /= Void

set_type (a_type: TYPE)

effective procedure

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC}

require

a_type /= Void

type: TYPE

writable attribute

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC, EIFFELDOC_COMMENT_STATE, EIFFELDOC_CORE, EIFFELDOC_SHORTER, EIFFELDOC_COMMENT_WRITER}

html: EIFFELDOC_OUTPUT_STREAM

writable attribute

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC, EIFFELDOC_COMMENT_STATE, EIFFELDOC_CORE, EIFFELDOC_SHORTER, EIFFELDOC_COMMENT_WRITER}

class_type: TYPE

writable attribute

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC, EIFFELDOC_COMMENT_STATE, EIFFELDOC_CORE, EIFFELDOC_SHORTER, EIFFELDOC_COMMENT_WRITER}

class_text: CLASS_TEXT

writable attribute

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC, EIFFELDOC_COMMENT_STATE, EIFFELDOC_CORE, EIFFELDOC_SHORTER, EIFFELDOC_COMMENT_WRITER}

options: EIFFELDOC_OPTIONS

writable attribute

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC, EIFFELDOC_COMMENT_STATE, EIFFELDOC_CORE, EIFFELDOC_SHORTER, EIFFELDOC_COMMENT_WRITER}

write_comment (comment: COMMENT, from_sentence: INTEGER_32, to_sentence: INTEGER_32)

effective procedure

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC, EIFFELDOC_COMMENT_STATE, EIFFELDOC_CORE, EIFFELDOC_SHORTER, EIFFELDOC_COMMENT_WRITER}

write_feature_comment (a_comment: COMMENT, for_feature: ANONYMOUS_FEATURE, from_sentence: INTEGER_32, to_sentence: INTEGER_32)

effective procedure

{EIFFELDOC, EIFFELDOC_SHORTER_CLASSDOC, EIFFELDOC_COMMENT_STATE, EIFFELDOC_CORE, EIFFELDOC_SHORTER, EIFFELDOC_COMMENT_WRITER}

all_states: FAST_ARRAY[EIFFELDOC_COMMENT_STATE]

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

All the known states.

The order is very important.

hidden_comment, in_bullet_list, in_numbered_list, in_preformatted must be before beginning_of_line because they all use line beginnings
in_url must be before in_wiki_word, because they both use brackets
in_bold, in_italics and in_character must be in this order because they all use quotes
in_text must be last because it handles anything not handled by another state

hidden_comment: EIFFELDOC_COMMENT_STATE_HIDDEN

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_bullet_list: EIFFELDOC_COMMENT_STATE_IN_BULLET_LIST

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_numbered_list: EIFFELDOC_COMMENT_STATE_IN_NUMBERED_LIST

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_preformatted: EIFFELDOC_COMMENT_STATE_IN_PREFORMATTED

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

beginning_of_line: EIFFELDOC_COMMENT_STATE_BEGINNING_OF_LINE

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_text: EIFFELDOC_COMMENT_STATE_IN_TEXT

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_class_name: EIFFELDOC_COMMENT_STATE_IN_CLASS_NAME

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_entity_name: EIFFELDOC_COMMENT_STATE_IN_ENTITY_NAME

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_url: EIFFELDOC_COMMENT_STATE_IN_URL

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_wiki_word: EIFFELDOC_COMMENT_STATE_IN_WIKI_WORD

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_bold: EIFFELDOC_COMMENT_STATE_IN_BOLD

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_italics: EIFFELDOC_COMMENT_STATE_IN_ITALICS

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_character: EIFFELDOC_COMMENT_STATE_IN_CHARACTER

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

in_string: EIFFELDOC_COMMENT_STATE_IN_STRING

frozen

once function

{EIFFELDOC_COMMENT_WRITER}

make

effective procedure

{}

comment_writer: EIFFELDOC_COMMENT_WRITER

writable attribute

{}