EDoc API
Overview Cluster Class Classes Index          Top Features

edoc

Class EDOC_OPTIONS


Creation

Features

Invariants

indexing

description

Various options for input, output and parser

copyright

Copyright (c) 2005, Julian Tschannen

license

Eiffel Forum License v2 (see forum.txt)

class EDOC_OPTIONS

create

make

-- Initialise context.

feature -- Access

xace_title: STRING

-- Title of main xace-file (either system or library)

feature -- Access (HTML)

original_css_file: STRING

-- Absolute path to original css file

short_title: STRING

-- Short title

title: STRING

-- Documentation title

version: STRING

-- Version

feature -- Access (Input)

ace_file: STRING

-- Input ace file

ignored_clusters: DS_LIST[STRING]

-- Ignored clusters (subclusters are ignored also)

mounted_libraries: DS_LIST[STRING]

-- XAce files of mounted libraries

xace_library: STRING

-- XAce file of library

xace_system: STRING

-- XAce file of system

feature -- Access (Output)

output_directory: STRING

-- Output directory

feature -- Access (Parser)

feature_clause_order: DS_LIST[STRING]

-- Feature clause order

ignored_feature_clauses: DS_LIST[STRING]

-- Ignored feature clauses

ignored_indexing_tags: DS_LIST[STRING]

-- Ignored indexing tags

ignored_inherit_classes: DS_LIST[STRING]

-- Ignored inherit classes

user_defined_feature_clause_index: INTEGER

-- Feature clause index of user defined clauses

feature -- Element change (HTML)

set_original_css_file (a_filename: like original_css_file)

-- Set original_css_file to a_filename.

require

a_filename_not_void: a_filename /= Void

ensure

original_css_file_set: original_css_file = a_filename

set_short_title (a_string: like short_title)

-- Set short_title to a_string.

require

a_string_not_void: a_string /= Void

ensure

short_title_set: short_title = a_string

set_title (a_string: like title)

-- Set title to a_string.

require

a_string_not_void: a_string /= Void

ensure

title_set: title = a_string

set_version (a_string: like version)

-- Set version to a_string.

require

a_string_not_void: a_string /= Void

ensure

version_set: version = a_string

feature -- Element change (Input)

set_ace_file (a_file: like ace_file)

-- Set ace_file to a_file.

require

a_file_not_void: a_file /= Void

ensure

ace_file_set: ace_file = a_file

set_xace_library (a_file: like xace_library)

-- Set xace_library to a_file.

require

a_file_not_void: a_file /= Void

ensure

xace_library_set: xace_library = a_file

set_xace_system (a_file: like xace_system)

-- Set xace_system to a_file.

require

a_file_not_void: a_file /= Void

ensure

xace_system_set: xace_system = a_file

feature -- Element change (Output)

set_output_direcotry (a_directory: like output_directory)

-- Set output_directory to a_directory.

require

a_directory_not_void: a_directory /= Void

ensure

output_directory_set: output_directory = a_directory

feature -- Status report (Input)

are_mounted_libraries_included: BOOLEAN

-- Are mounted libraries included?

feature -- Status report (Output)

are_cluster_files_generated: BOOLEAN

-- Are cluster files generated?

are_usage_files_generated: BOOLEAN

-- Are usage files generated?

is_ancestors_list_generated: BOOLEAN

-- Is an ancestors list generated?

is_classes_file_generated: BOOLEAN

-- Is a classes file generated?

is_descendants_list_generated: BOOLEAN

-- Is a descendants list generated?

is_feature_list_generated: BOOLEAN

-- Is a features list generated?

is_index_generated: BOOLEAN

-- Is an index generated?

is_inherit_tree_generated: BOOLEAN

-- Is an inheritance tree generated?

is_output_flat: BOOLEAN

-- Is output flat?
-- Yes means all files will be in the same directory.
-- No means a directory structure similar to the cluster structure is used.

is_overview_generated: BOOLEAN

-- Is an overview page generated?

feature -- Status report (Parser)

are_classes_flat: BOOLEAN

-- Are classes in flat form?

is_feature_clause_export_none_ignored: BOOLEAN

-- Are feature clauses ignored which are exported to NONE?

is_inherit_export_none_ignored: BOOLEAN

-- Are classes ignored which are exported to NONE?

feature -- Status setting (Input)

set_mounted_libraries_included (a_value: like are_mounted_libraries_included)

-- Set are_mounted_libraries_included to a_value.

ensure

are_mounted_libraries_included_set: are_mounted_libraries_included = a_value

feature -- Status setting (Output)

set_ancestors_list_generated (a_value: like is_ancestors_list_generated)

-- Set is_ancestors_list_generated to a_value.

ensure

is_ancestors_list_generated_set: is_ancestors_list_generated = a_value

set_classes_file_generated (a_value: like is_classes_file_generated)

-- Set is_classes_file_generated to a_value.

ensure

is_classes_file_generated_set: is_classes_file_generated = a_value

set_cluster_files_generated (a_value: like are_cluster_files_generated)

-- Set are_cluster_files_generated to a_value.

ensure

are_cluster_files_generated_set: are_cluster_files_generated = a_value

set_descendants_list_generated (a_value: like is_descendants_list_generated)

-- Set is_descendants_list_generated to a_value.

ensure

is_descendants_list_generated_set: is_descendants_list_generated = a_value

set_feature_list_generated (a_value: like is_feature_list_generated)

-- Set is_feature_list_generated to a_value.

ensure

is_feature_list_generated_set: is_feature_list_generated = a_value

set_index_generated (a_value: like is_index_generated)

-- Set is_index_generated to a_value.

ensure

is_index_generated_set: is_index_generated = a_value

set_inherit_tree_generated (a_value: like is_inherit_tree_generated)

-- Set is_inherit_tree_generated to a_value.

ensure

is_inherit_tree_generated_set: is_inherit_tree_generated = a_value

set_output_flat (a_value: like is_output_flat)

-- Set is_output_flat to a_value.

ensure

is_output_flat_set: is_output_flat = a_value

set_overview_generated (a_value: like is_overview_generated)

-- Set is_overview_generated to a_value.

ensure

is_overview_generated_set: is_overview_generated = a_value

set_usage_files_generated (a_value: like are_usage_files_generated)

-- Set are_usage_files_generated to a_value.

ensure

are_usage_files_generated_set: are_usage_files_generated = a_value

feature -- Status setting (Parser)

set_classes_flat (a_value: like are_classes_flat)

-- Set are_classes_flat to a_value.

ensure

are_classes_flat_set: are_classes_flat = a_value

set_feature_clause_export_none_ignored (a_value: like is_feature_clause_export_none_ignored)

ensure

is_feature_clause_export_none_ignored_set: is_feature_clause_export_none_ignored = a_value

set_inherit_export_none_ignored (a_value: like is_inherit_export_none_ignored)

-- Set is_inherit_export_none_ignored to a_value.

ensure

is_inherit_export_none_ignored_set: is_inherit_export_none_ignored = a_value

set_user_defined_feature_clause_index (a_value: like user_defined_feature_clause_index)

ensure

user_defined_feature_clause_index_set: user_defined_feature_clause_index = a_value

invariant

output_directory_not_void: output_directory /= Void
ignored_indexing_tags_not_void: ignored_indexing_tags /= Void
feature_clause_order_not_void: feature_clause_order /= Void
ignored_inherit_classes_not_void: ignored_inherit_classes /= Void
ignored_feature_clauses_not_void: ignored_feature_clauses /= Void
ignored_clusters_not_void: ignored_clusters /= Void
mounted_libraries_not_void: mounted_libraries /= Void

-- From ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)