Permalink
Browse files

docs: Rename marckdown files, clean them up and add them to doxygen d…

…ocs.
  • Loading branch information...
b1v1r committed Mar 7, 2013
1 parent 300634f commit 447c716495eab9c8a23540ecefb701ff1512ffa8
Showing with 24 additions and 11 deletions.
  1. +1 −3 CHANGES → CHANGES.md
  2. +9 −6 DEVELOPMENT → DEVELOPMENT.md
  3. +3 −0 README → README.md
  4. +6 −2 configure.ac
  5. +5 −0 include/ironbee/apidoc.h
View
@@ -1,6 +1,4 @@
-Title: IronBee Changes
-
-IronBee Changes
+IronBee Changes {#CHANGES}
===============
IronBee v0.7.0
@@ -1,5 +1,8 @@
+IronBee Development {#DEVELOPMENT}
+===================
+
Source Code Repository
-======================
+----------------------
IronBee code is availalbe via a git source code repository from git-hub. The
latest source is always available from here as are all releases.
@@ -48,7 +51,7 @@ Generate a patch:
LuaJIT Code
-===========
+-----------
LuaJIT is currently distributed with IronBee as it is not widely available. The
source is in libs/luajit-2.0-ironbee and is included using git-subtree with full
@@ -66,7 +69,7 @@ Then you can merge in the upstream source with:
LibInjection Code
-=================
+-----------------
The libinjection code is currently distributed with IronBee as it is not widely
available. The source is in libs/libinjection and is included using git-subtree
@@ -83,7 +86,7 @@ Then you can merge in the upstream source with:
Coding Style
-============
+------------
Please read and understand the coding style from the guide, "CODESTYLE".
@@ -92,7 +95,7 @@ rejected.
Contributing
-============
+------------
To contribute code to the project, you will need to be using git to format
patches which you can email to the team.
@@ -141,7 +144,7 @@ patches which you can email to the team.
Ongoing Contributions
-=====================
+---------------------
If you or your group will have ongoing contributions, then you should consider
using Github's "fork" feature instead of sending in patches. This forks a
View
@@ -1,3 +1,6 @@
+IronBee {#README}
+=======
+
IronBee is a new open source project to build a universal web application
security sensor. This repository contains the core IronBee engine and
development framework for extending IronBee.
View
@@ -8,7 +8,7 @@ AC_INIT([ironbee],
m4_esyscmd([./get-version.sh VERSION]),
[ironbee-team@ironbee.com])
-AC_CONFIG_MACRO_DIR([acinclude]) AC_CONFIG_SRCDIR([README])
+AC_CONFIG_MACRO_DIR([acinclude]) AC_CONFIG_SRCDIR([README.md])
AC_CONFIG_HEADERS([ironbee_config_auto_gen.h])
AC_CONFIG_AUX_DIR([build])
AC_PREFIX_DEFAULT([/usr/local/ironbee])
@@ -255,14 +255,18 @@ fi
DOXYGEN=$doxygen
+DOXYGEN_TOP=`cd $srcdir;pwd`
DOXYGEN_DIRS="include util engine modules automata fast"
+MARKDOWN_DOXYGEN_FILES=`cd $srcdir;find . lua -type f -depth 1 -name '*.md'`
EXTERNAL_DOXYGEN_FILES=`cd $srcdir;find $DOXYGEN_DIRS -type f -name '*.h' -o -name '*.hpp'`
INTERNAL_DOXYGEN_FILES=`cd $srcdir;find $DOXYGEN_DIRS -type f -name '*.h' -o -name '*.hpp' -o -name '*.c' -o -name '*.cpp' -o -name '*.cc'`
DOXYGEN_INPUT=""
-DOXYGEN_TOP=`cd $srcdir;pwd`
for dir in $DOXYGEN_DIRS; do
DOXYGEN_INPUT="$DOXYGEN_INPUT $DOXYGEN_TOP/$dir"
done
+for dir in $MARKDOWN_DOXYGEN_FILES; do
+ DOXYGEN_INPUT="$DOXYGEN_INPUT $DOXYGEN_TOP/$dir"
+done
DOXYGEN_EXTERNAL_DEPS=""
for f in $EXTERNAL_DOXYGEN_FILES; do
DOXYGEN_EXTERNAL_DEPS="$DOXYGEN_EXTERNAL_DEPS \$(abs_top_srcdir)/$f"
View
@@ -33,6 +33,11 @@
* If you are a module, rule, or server writer, you are probably interested in
* the public API. See the Modules list and the files in include/ironbee.
*
+ * Some general documentation on IronBee and development from the codebase:
+ * - @ref README
+ * - @ref CHANGES
+ * - @ref DEVELOPMENT
+ *
* Of particular interest:
* - Module writers: module.h, module_sym.h
* - Server writers: server.h, state_notify.h

0 comments on commit 447c716

Please sign in to comment.