EDoc API
Overview Cluster Class Classes Index          Top Features

edoc.html_output

Class EDOC_HTML_OUTPUT


Direct ancestors

EDOC_OUTPUT, EDOC_SHARED_HTML_CONTEXT

Creation

Features

Invariants

indexing

description

Output as HTML files

copyright

Copyright (c) 2005, Julian Tschannen

license

Eiffel Forum License v2 (see forum.txt)

class EDOC_HTML_OUTPUT

inherit

EDOC_OUTPUT
KL_SHARED_FILE_SYSTEM
EDOC_SHARED_ACCESS

create

make

-- Initialise default values.

ensure

default_options_filename_set: default_options_filename /= Void

feature -- Access

Class_sorter: DS_QUICK_SORTER[ET_CLASS]

-- Shared class sorter
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

Cluster_sorter: DS_QUICK_SORTER[ET_CLUSTER]

-- Shared cluster sorter
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

Feature_clause_sorter: DS_QUICK_SORTER[PAIR[ET_FEATURE_CLAUSE, PAIR[INTEGER, STRING]]]

-- Shared feature sorter.
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

Feature_sorter: DS_QUICK_SORTER[ET_FEATURE]

-- Shared feature sorter.
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

Index_sorter: DS_QUICK_SORTER[EDOC_INDEX_ENTRY]

-- Shared index sorter
-- (From EDOC_SHARED_ACCESS)

ensure

result_not_void: Result /= Void

default_options_filename: STRING

-- Name of default options file
-- (From EDOC_OUTPUT)

output_directory: STRING

-- Directory to store generated files
-- (From EDOC_OUTPUT)

feature -- Element change

set_output_directory (a_directory: STRING)

-- Set 'output_directory' to 'a_directory'.
-- (From EDOC_OUTPUT)

require

a_directory_not_void: a_directory /= Void

ensure

output_directory_set: output_directory.is_equal (file_system.canonical_pathname (a_directory))
output_direcotry_exists: file_system.directory_exists (a_directory)

feature -- File creation

generate_additional_files

-- Generate additional files needed for output.
-- (From EDOC_OUTPUT)

require

output_directory_not_void: output_directory /= Void
output_directory_exists: file_system.directory_exists (output_directory)

generate_class_file (a_class: ET_CLASS)

-- Generate file for a_class in 'output_directory'.
-- (From EDOC_OUTPUT)

require

a_class_not_void: a_class /= Void
output_directory_not_void: output_directory /= Void
output_directory_exists: file_system.directory_exists (output_directory)

generate_classes_file (a_class_list: DS_LIST[ET_CLASS])

-- Generate file for a_class_list in output_directory.
-- (From EDOC_OUTPUT)

require

a_class_list_not_void: a_class_list /= Void
output_directory_not_void: output_directory /= Void
output_directory_exists: file_system.directory_exists (output_directory)

generate_cluster_file (a_cluster: ET_CLUSTER)

-- Generate file for a_cluster in 'output_directory'.
-- (From EDOC_OUTPUT)

require

a_cluster_not_void: a_cluster /= Void
output_directory_not_void: output_directory /= Void
output_directory_exists: file_system.directory_exists (output_directory)

generate_index (an_index_list: DS_LIST[EDOC_INDEX_ENTRY])

-- Generate index for an_index_list in output_directory.
-- (From EDOC_OUTPUT)

require

an_index_list_not_void: an_index_list /= Void
an_index_list_sorted: Index_sorter.sorted (an_index_list)
output_directory_not_void: output_directory /= Void
output_directory_exists: file_system.directory_exists (output_directory)

generate_overview

-- Generate overview in output_directory.
-- (From EDOC_OUTPUT)

require

output_directory_not_void: output_directory /= Void
output_directory_exists: file_system.directory_exists (output_directory)

generate_usage_file (a_class: ET_CLASS)

-- Generate usage file for a_class in output_directory.
-- (From EDOC_OUTPUT)

require

a_class_not_void: a_class /= Void
output_directory_not_void: output_directory /= Void
output_directory_exists: file_system.directory_exists (output_directory)

options_file (a_filename: STRING): EDOC_OPTIONS_FILE

-- Create options file for html output.
-- (From EDOC_OUTPUT)

require

a_filename_not_void: a_filename /= Void

ensure

options_file_not_void: Result /= Void

feature -- File systems

file_system: KL_FILE_SYSTEM

-- Underlying file system
-- (From KL_SHARED_FILE_SYSTEM)

ensure

file_system_not_void: Result /= Void
current_file_system: Result.is_current_file_system

unix_file_system: KL_UNIX_FILE_SYSTEM

-- Unix-like file system
-- (From KL_SHARED_FILE_SYSTEM)

ensure

file_system_not_void: Result /= Void

windows_backslash_only_file_system: KL_WINDOWS_FILE_SYSTEM

-- Windows-like file system which accepts only \ as
-- directory separator
-- (From KL_SHARED_FILE_SYSTEM)

ensure

file_system_not_void: Result /= Void

windows_file_system: KL_WINDOWS_FILE_SYSTEM

-- Windows-like file system which accepts both
-- \ and / as directory separator
-- (From KL_SHARED_FILE_SYSTEM)

ensure

file_system_not_void: Result /= Void

invariant

-- From EDOC_OUTPUT
default_options_file_not_void: default_options_filename /= Void

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