Pārlūkot izejas kodu

Adjust design overview docs to other multi-page docs

- Link to other pages in index.adoc
- Include other pages in design-overview.adoc

Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
tags/V1_9_21_1
Alexander Kriegisch pirms 5 mēnešiem
vecāks
revīzija
ac71008e59
2 mainītis faili ar 35 papildinājumiem un 3 dzēšanām
  1. 30
    0
      docs/developer/design-overview.adoc
  2. 5
    3
      docs/developer/index.adoc

+ 30
- 0
docs/developer/design-overview.adoc Parādīt failu

@@ -0,0 +1,30 @@
= AspectJ Design Overview
:doctype: book

Here are some sobering words:

"Although it is essential to upgrade software to prevent aging, changing software can cause a different form of
aging. The designer of a piece of software usually had a simple concept in mind when writing the program. If the
program is large, understanding the concept allows one to find those sections of the program that must be altered
when an update or correction is needed. Understanding that concept also implies understanding the interfaces used
within the system and between the system and its environment. Changes made by people who do not understand the
original design concept almost always cause the structure of the program to degrade. Under those circumstances,
changes will be inconsistent with the original concept; in fact, they will invalidate the original concept. Sometimes
the damage is small, but often it is quite severe. After those changes, one must know both the original design rules
and the newly introduced exceptions to the rules, to understand the product. After many such changes, the original
designers no longer understand the product. Those who made the changes, never did. In other words, *nobody*
understands the modified product." +
+
Software that has been repeatedly modified (maintained) in this way becomes very expensive to update. Changes take
longer and are more likely to introduce new 'bugs'."
-- David Parnas on "Ignorant Surgery" in his paper on Software Aging

////
ATTENTION: Please do not remove blank lines in between 'include::' statements. Otherwise, section numbers in the
table of contents (TOC) can be wrong and the first section of each document missing completely.
////
include::compiler-weaver/index.adoc[Guide for Developers of the AspectJ Compiler and Weaver]

include::modules.adoc[Module Structure]

include::language.adoc[Language Design]

+ 5
- 3
docs/developer/index.adoc Parādīt failu

@@ -19,6 +19,8 @@ Software that has been repeatedly modified (maintained) in this way becomes very
longer and are more likely to introduce new 'bugs'."
-- David Parnas on "Ignorant Surgery" in his paper on Software Aging

include::compiler-weaver/index.adoc[Guide for Developers of the AspectJ Compiler and Weaver]
include::modules.adoc[Module Structure]
include::language.adoc[Language Design]
**Table of Contents**

* xref:compiler-weaver/index.adoc[Guide for Developers of the AspectJ Compiler and Weaver]
* xref:modules.adoc[Module Structure]
* xref:language.adoc[Language Design]

Notiek ielāde…
Atcelt
Saglabāt