From dc6976e3736554318e79b6f61f03691b7b37bc8d Mon Sep 17 00:00:00 2001 From: Chris Date: Wed, 11 Apr 2012 11:52:50 +0100 Subject: [PATCH] More documentation fixes. --- README.md | 5 +++++ mdfiles/overview.md | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 10831e6..63013f1 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,8 @@ see: Once you have Doxygen and Doxygen Perl Filter installed, run the 'makedocs.sh' script in the main directory to generate the documentation. + +Why Doxygen instead of POD? Mainly personal preference: I find documentation +written using doxygen formatting and markup vastly easier to write, and much +easier to read, than POD documentation. Doxygen also provides better output +than most POD tools. But if you disagree, there's a 'fork' button on github... diff --git a/mdfiles/overview.md b/mdfiles/overview.md index 57ffe8d..66f2c2a 100644 --- a/mdfiles/overview.md +++ b/mdfiles/overview.md @@ -66,7 +66,7 @@ specific aspects of the library: * [Blocks](@ref blocks) discusses the purpose, loading, and features of the Block class and subclasses you may with to implement in your application. -* [Structure](@ref structure) covers the suggested layout of files and directories. +* [Structure](@ref appstructure) covers the suggested layout of files and directories. * [Configuration](@ref config) discusses the core configuration file, and the optional settings table in the database. * [Sessions](@ref sessions) introduces the session handling feature of the