From b0d37c4b51a344bee94bb7f7cc1ecef1a233e3ab Mon Sep 17 00:00:00 2001 From: wisberg Date: Wed, 6 Aug 2003 02:06:20 +0000 Subject: document new contents of docs module --- docs/readme-docs-module.html | 44 ++++++++++++++++++++++++++++++++++---------- 1 file changed, 34 insertions(+), 10 deletions(-) (limited to 'docs') diff --git a/docs/readme-docs-module.html b/docs/readme-docs-module.html index fdb7866a1..28f9647d3 100644 --- a/docs/readme-docs-module.html +++ b/docs/readme-docs-module.html @@ -3,16 +3,40 @@

AspectJ docs

-The AspectJ docs include native sources (html and word files) -and XML DocBook files used to produce the FAQ and guides. -The dist directory contains the native files -as they are delivered with the distribution, and the -docbook directories - faq, - progGuideDB, and - devGuideDB -contain sources for the FAQ and the Programming and Development Guides, -generated using the Ant build.xml script. +This module contains the sources for the documentation +delivered with the AspectJ distribution and +for various internal, teaching, and online works: +

devGuideDB: DocBook sources + for the AspectJ Development Environment Guide
progGuideDB: DocBook sources + for the AspectJ Programming Language Guide
faq: DocBook sources + for the AspectJ Frequently Asked Questions
sandbox: a collection of sample + AspectJ programs, tools built on the AspectJ API's, + script snippets, and instructional trails, all intended + to serve as sources for documentation. + See + sandbox/readme-sandbox.html
teaching: Teaching materials, esp. + for the AspectJ tutorials.
quick.doc: The Microsoft Word + source file for the .pdf Quick Reference guides + dist/doc/quick.pdf and + dist/doc/quickA4.pdf.
build.xml: Ant build script for + the doc distribution
developer: Docs for AspectJ developers. + See the overview.html

Build: build.xml assembles a local -- cgit v1.2.3