---------------------
PatchSet 5051 
Date: 2007/07/12 01:08:08
Author: amosjeffries
Branch: docs
Tag: (none) 
Log:
Add structure for Storage API module docs.
Link in UFS, diskd, AUFS module auto-docs.

Members: 
	src/fs/FileSystems.dox:1.1->1.1.2.1 
	src/fs/aufs/StoreFSaufs.cc:1.2->1.2.24.1 
	src/fs/diskd/StoreFSdiskd.cc:1.2->1.2.24.1 
	src/fs/ufs/StoreFSufs.h:1.5->1.5.10.1 
	src/fs/ufs/ufscommon.h:1.9->1.9.10.1 

--- /dev/null	Mon Jul 23 00:19:28 2007
+++ squid3/src/fs/FileSystems.dox	Mon Jul 23 00:19:28 2007
@@ -0,0 +1,9 @@
+/**
+\defgroup FileSystems	Storage Filesystems
+\ingroup Modules
+
+\todo DOCS: pull generic FS documentation into here
+	individual FS documentation goes in its source files.
+	and the FS gets its own API group which is \ingroup FielSystems
+
+ */
Index: squid3/src/fs/aufs/StoreFSaufs.cc
===================================================================
RCS file: /cvsroot/squid-sf//squid3/src/fs/aufs/StoreFSaufs.cc,v
retrieving revision 1.2
retrieving revision 1.2.24.1
diff -u -r1.2 -r1.2.24.1
--- squid3/src/fs/aufs/StoreFSaufs.cc	21 Dec 2004 03:14:34 -0000	1.2
+++ squid3/src/fs/aufs/StoreFSaufs.cc	12 Jul 2007 01:08:09 -0000	1.2.24.1
@@ -1,6 +1,6 @@
 
 /*
- * $Id: StoreFSaufs.cc,v 1.2 2004/12/21 03:14:34 squidadm Exp $
+ * $Id: StoreFSaufs.cc,v 1.2.24.1 2007/07/12 01:08:09 amosjeffries Exp $
  *
  * DEBUG: section 47    Store Directory Routines
  * AUTHOR: Robert Collins
@@ -39,4 +39,12 @@
 #include "fs/ufs/StoreFSufs.h"
 #include "DiskIO/DiskIOModule.h"
 
+/**
+ * \defgroup AUFS AUFS Storage Filesystem (UFS Based)
+ * \ingroup UFS, FileSystems
+ */
+
+/**
+ * \ingroup AUFS
+ */
 static StoreFSufs<UFSSwapDir> AufsInstance("DiskThreads", "aufs");
Index: squid3/src/fs/diskd/StoreFSdiskd.cc
===================================================================
RCS file: /cvsroot/squid-sf//squid3/src/fs/diskd/StoreFSdiskd.cc,v
retrieving revision 1.2
retrieving revision 1.2.24.1
diff -u -r1.2 -r1.2.24.1
--- squid3/src/fs/diskd/StoreFSdiskd.cc	21 Dec 2004 03:14:36 -0000	1.2
+++ squid3/src/fs/diskd/StoreFSdiskd.cc	12 Jul 2007 01:08:09 -0000	1.2.24.1
@@ -1,6 +1,6 @@
 
 /*
- * $Id: StoreFSdiskd.cc,v 1.2 2004/12/21 03:14:36 squidadm Exp $
+ * $Id: StoreFSdiskd.cc,v 1.2.24.1 2007/07/12 01:08:09 amosjeffries Exp $
  *
  * DEBUG: section 47    Store Directory Routines
  * AUTHOR: Robert Collins
@@ -39,4 +39,12 @@
 #include "fs/ufs/StoreFSufs.h"
 #include "DiskIO/DiskIOModule.h"
 
+/**
+ * \defgroup diskd diskd Storage Filesystem (UFS Based)
+ * \ingroup FileSystems, UFS
+ */
+
+/**
+ * \ingroup diskd
+ */
 static StoreFSufs<UFSSwapDir> DiskdInstance("DiskDaemon", "diskd");
Index: squid3/src/fs/ufs/StoreFSufs.h
===================================================================
RCS file: /cvsroot/squid-sf//squid3/src/fs/ufs/StoreFSufs.h,v
retrieving revision 1.5
retrieving revision 1.5.10.1
diff -u -r1.5 -r1.5.10.1
--- squid3/src/fs/ufs/StoreFSufs.h	14 Sep 2006 01:50:33 -0000	1.5
+++ squid3/src/fs/ufs/StoreFSufs.h	12 Jul 2007 01:08:09 -0000	1.5.10.1
@@ -1,6 +1,6 @@
 
 /*
- * $Id: StoreFSufs.h,v 1.5 2006/09/14 01:50:33 squidadm Exp $
+ * $Id: StoreFSufs.h,v 1.5.10.1 2007/07/12 01:08:09 amosjeffries Exp $
  *
  * SQUID Web Proxy Cache          http://www.squid-cache.org/
  * ----------------------------------------------------------
@@ -38,8 +38,14 @@
 #include "ufscommon.h"
 #include "DiskIO/DiskIOModule.h"
 
+/**
+ * \defgroup UFS	UFS Storage Filesystem
+ * \ingroup FileSystems
+ */
 
-/* core UFS class. This template provides compile time aliases for
+/**
+ * \ingroup UFS, FileSystems
+ * Core UFS class. This template provides compile time aliases for
  * ufs/aufs/diskd to ease configuration conversion - each becomes a 
  * StoreFS module whose createSwapDir method parameterises the common
  * UFSSwapDir with an IO module instance.
Index: squid3/src/fs/ufs/ufscommon.h
===================================================================
RCS file: /cvsroot/squid-sf//squid3/src/fs/ufs/ufscommon.h,v
retrieving revision 1.9
retrieving revision 1.9.10.1
diff -u -r1.9 -r1.9.10.1
--- squid3/src/fs/ufs/ufscommon.h	14 Sep 2006 01:50:33 -0000	1.9
+++ squid3/src/fs/ufs/ufscommon.h	12 Jul 2007 01:08:09 -0000	1.9.10.1
@@ -1,6 +1,6 @@
 
 /*
- * $Id: ufscommon.h,v 1.9 2006/09/14 01:50:33 squidadm Exp $
+ * $Id: ufscommon.h,v 1.9.10.1 2007/07/12 01:08:09 amosjeffries Exp $
  *
  * SQUID Web Proxy Cache          http://www.squid-cache.org/
  * ----------------------------------------------------------
@@ -50,6 +50,9 @@
 
 class DiskIOModule;
 
+/**
+ * \ingroup UFS
+ */
 class UFSSwapDir : public SwapDir
 {
 
@@ -157,6 +160,9 @@
 
 class DiskFile;
 
+/**
+ * \ingroup UFS
+ */
 class UFSStrategy
 {
 
@@ -201,6 +207,9 @@
 
 class ReadRequest;
 
+/**
+ * \ingroup UFS
+ */
 class UFSStoreState : public StoreIOState, public IORequestor
 {
 
@@ -292,6 +301,9 @@
 MEMPROXY_CLASS_INLINE(UFSStoreState::_queued_read)
 MEMPROXY_CLASS_INLINE(UFSStoreState::_queued_write)
 
+/**
+ * \ingroup UFS
+ */
 class StoreSearchUFS : public StoreSearch
 {
 
@@ -321,6 +333,9 @@
     bool _done;
 };
 
+/**
+ * \ingroup UFS
+ */
 class RebuildState : public RefCountable
 {