--------------------- PatchSet 5010 Date: 2007/07/12 04:18:03 Author: amosjeffries Branch: docs Tag: (none) Log: Finish Module-Linking all the FS types. Members: src/fs/aufs/StoreFSaufs.cc:1.2.24.1->1.2.24.2 src/fs/coss/CossSwapDir.h:1.6->1.6.14.1 src/fs/coss/StoreFScoss.h:1.3->1.3.14.1 src/fs/coss/store_coss.h:1.14->1.14.10.1 src/fs/diskd/StoreFSdiskd.cc:1.2.24.1->1.2.24.2 src/fs/null/StoreFSnull.h:1.1->1.1.32.1 src/fs/null/store_null.h:1.3->1.3.14.1 src/fs/ufs/StoreFSufs.h:1.5.10.1->1.5.10.2 src/fs/ufs/ufscommon.h:1.9.10.1->1.9.10.2 Index: squid3/src/fs/aufs/StoreFSaufs.cc =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/fs/aufs/StoreFSaufs.cc,v retrieving revision 1.2.24.1 retrieving revision 1.2.24.2 diff -u -r1.2.24.1 -r1.2.24.2 --- squid3/src/fs/aufs/StoreFSaufs.cc 12 Jul 2007 01:08:09 -0000 1.2.24.1 +++ squid3/src/fs/aufs/StoreFSaufs.cc 12 Jul 2007 04:18:03 -0000 1.2.24.2 @@ -1,6 +1,6 @@ /* - * $Id: StoreFSaufs.cc,v 1.2.24.1 2007/07/12 01:08:09 amosjeffries Exp $ + * $Id: StoreFSaufs.cc,v 1.2.24.2 2007/07/12 04:18:03 amosjeffries Exp $ * * DEBUG: section 47 Store Directory Routines * AUTHOR: Robert Collins @@ -44,7 +44,5 @@ * \ingroup UFS, FileSystems */ -/** - * \ingroup AUFS - */ +/// \ingroup AUFS static StoreFSufs AufsInstance("DiskThreads", "aufs"); Index: squid3/src/fs/coss/CossSwapDir.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/fs/coss/CossSwapDir.h,v retrieving revision 1.6 retrieving revision 1.6.14.1 diff -u -r1.6 -r1.6.14.1 --- squid3/src/fs/coss/CossSwapDir.h 23 May 2006 00:45:42 -0000 1.6 +++ squid3/src/fs/coss/CossSwapDir.h 12 Jul 2007 04:18:03 -0000 1.6.14.1 @@ -27,6 +27,7 @@ #include "DiskIO/DiskFile.h" #include "DiskIO/IORequestor.h" +/// \ingroup COSS class CossSwapDir : public SwapDir, public IORequestor { @@ -92,10 +93,14 @@ const char *stripe_path; }; +/// \ingroup COSS extern void storeCossAdd(CossSwapDir *, StoreEntry *); +/// \ingroup COSS extern void storeCossRemove(CossSwapDir *, StoreEntry *); +/// \ingroup COSS extern void storeCossStartMembuf(CossSwapDir * SD); +/// \ingroup COSS class StoreSearchCoss : public StoreSearch { Index: squid3/src/fs/coss/StoreFScoss.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/fs/coss/StoreFScoss.h,v retrieving revision 1.3 retrieving revision 1.3.14.1 diff -u -r1.3 -r1.3.14.1 --- squid3/src/fs/coss/StoreFScoss.h 29 May 2006 00:50:19 -0000 1.3 +++ squid3/src/fs/coss/StoreFScoss.h 12 Jul 2007 04:18:03 -0000 1.3.14.1 @@ -1,6 +1,6 @@ /* - * $Id: StoreFScoss.h,v 1.3 2006/05/29 00:50:19 squidadm Exp $ + * $Id: StoreFScoss.h,v 1.3.14.1 2007/07/12 04:18:03 amosjeffries Exp $ * * SQUID Web Proxy Cache http://www.squid-cache.org/ * ---------------------------------------------------------- @@ -36,6 +36,12 @@ #include "StoreFileSystem.h" +/** + * \defgroup COSS COSS Storage Filesystem + * \ingroup FileSystems + */ + +/// \ingroup COSS class CossStats { @@ -66,6 +72,7 @@ open, create, close, unlink, read, write, stripe_write; }; +/// \ingroup COSS, FileSystems class StoreFScoss : public StoreFileSystem { Index: squid3/src/fs/coss/store_coss.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/fs/coss/store_coss.h,v retrieving revision 1.14 retrieving revision 1.14.10.1 diff -u -r1.14 -r1.14.10.1 --- squid3/src/fs/coss/store_coss.h 19 Sep 2006 08:52:40 -0000 1.14 +++ squid3/src/fs/coss/store_coss.h 12 Jul 2007 04:18:03 -0000 1.14.10.1 @@ -16,6 +16,7 @@ class CossSwapDir; +/// \ingroup COSS class CossMemBuf { @@ -37,6 +38,7 @@ } flags; }; +/// \ingroup COSS struct _cossindex { /* Note: the dlink_node MUST be the first member of the structure. @@ -47,8 +49,10 @@ -/* Per-storeiostate info */ - +/** + * \ingroup COSS + * Per-storeiostate info + */ class CossState : public StoreIOState { @@ -86,17 +90,26 @@ CossSwapDir *SD; }; +/// \ingroup COSS MEMPROXY_CLASS_INLINE(CossState) +/// \ingroup COSS typedef struct _cossindex CossIndexNode; -/* Whether the coss system has been setup or not */ + +/** + * \ingroup COSS + * Whether the coss system has been setup or not + */ extern int coss_initialised; +/// \ingroup COSS extern MemAllocator *coss_membuf_pool; +/// \ingroup COSS extern MemAllocator *coss_index_pool; #include "DiskIO/ReadRequest.h" +/// \ingroup COSS class CossRead : public ReadRequest { @@ -113,6 +126,7 @@ #include "DiskIO/WriteRequest.h" +/// \ingroup COSS class CossWrite : public WriteRequest { Index: squid3/src/fs/diskd/StoreFSdiskd.cc =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/fs/diskd/StoreFSdiskd.cc,v retrieving revision 1.2.24.1 retrieving revision 1.2.24.2 diff -u -r1.2.24.1 -r1.2.24.2 --- squid3/src/fs/diskd/StoreFSdiskd.cc 12 Jul 2007 01:08:09 -0000 1.2.24.1 +++ squid3/src/fs/diskd/StoreFSdiskd.cc 12 Jul 2007 04:18:03 -0000 1.2.24.2 @@ -1,6 +1,6 @@ /* - * $Id: StoreFSdiskd.cc,v 1.2.24.1 2007/07/12 01:08:09 amosjeffries Exp $ + * $Id: StoreFSdiskd.cc,v 1.2.24.2 2007/07/12 04:18:03 amosjeffries Exp $ * * DEBUG: section 47 Store Directory Routines * AUTHOR: Robert Collins @@ -44,7 +44,5 @@ * \ingroup FileSystems, UFS */ -/** - * \ingroup diskd - */ +/// \ingroup diskd static StoreFSufs DiskdInstance("DiskDaemon", "diskd"); Index: squid3/src/fs/null/StoreFSnull.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/fs/null/StoreFSnull.h,v retrieving revision 1.1 retrieving revision 1.1.32.1 diff -u -r1.1 -r1.1.32.1 --- squid3/src/fs/null/StoreFSnull.h 23 Jul 2003 02:12:52 -0000 1.1 +++ squid3/src/fs/null/StoreFSnull.h 12 Jul 2007 04:18:03 -0000 1.1.32.1 @@ -1,6 +1,6 @@ /* - * $Id: StoreFSnull.h,v 1.1 2003/07/23 02:12:52 squidadm Exp $ + * $Id: StoreFSnull.h,v 1.1.32.1 2007/07/12 04:18:03 amosjeffries Exp $ * * SQUID Web Proxy Cache http://www.squid-cache.org/ * ---------------------------------------------------------- @@ -36,6 +36,14 @@ #include "squid.h" +/** + * \defgroup NULL Memory-Only Filesystem + * \ingroup FileSystems + * + * Non-Disk storage system. cache_dir contents are held fully within RAM. + */ + +/// \ingroup NULL, FileSystems class StoreFSnull : public StoreFileSystem { Index: squid3/src/fs/null/store_null.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/fs/null/store_null.h,v retrieving revision 1.3 retrieving revision 1.3.14.1 diff -u -r1.3 -r1.3.14.1 --- squid3/src/fs/null/store_null.h 23 May 2006 00:49:27 -0000 1.3 +++ squid3/src/fs/null/store_null.h 12 Jul 2007 04:18:03 -0000 1.3.14.1 @@ -1,6 +1,6 @@ /* - * $Id: store_null.h,v 1.3 2006/05/23 00:49:27 squidadm Exp $ + * $Id: store_null.h,v 1.3.14.1 2007/07/12 04:18:03 amosjeffries Exp $ * * SQUID Web Proxy Cache http://www.squid-cache.org/ * ---------------------------------------------------------- @@ -38,6 +38,7 @@ #include "SwapDir.h" #include "StoreSearch.h" +/// \ingroup NULL class NullSwapDir : public SwapDir { @@ -52,6 +53,7 @@ virtual StoreSearch *search(String const url, HttpRequest *); }; +/// \ingroup NULL class StoreSearchNull : public StoreSearch { Index: squid3/src/fs/ufs/StoreFSufs.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/fs/ufs/StoreFSufs.h,v retrieving revision 1.5.10.1 retrieving revision 1.5.10.2 diff -u -r1.5.10.1 -r1.5.10.2 --- squid3/src/fs/ufs/StoreFSufs.h 12 Jul 2007 01:08:09 -0000 1.5.10.1 +++ squid3/src/fs/ufs/StoreFSufs.h 12 Jul 2007 04:18:03 -0000 1.5.10.2 @@ -1,6 +1,6 @@ /* - * $Id: StoreFSufs.h,v 1.5.10.1 2007/07/12 01:08:09 amosjeffries Exp $ + * $Id: StoreFSufs.h,v 1.5.10.2 2007/07/12 04:18:03 amosjeffries Exp $ * * SQUID Web Proxy Cache http://www.squid-cache.org/ * ---------------------------------------------------------- @@ -45,6 +45,7 @@ /** * \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 Index: squid3/src/fs/ufs/ufscommon.h =================================================================== RCS file: /cvsroot/squid-sf//squid3/src/fs/ufs/ufscommon.h,v retrieving revision 1.9.10.1 retrieving revision 1.9.10.2 diff -u -r1.9.10.1 -r1.9.10.2 --- squid3/src/fs/ufs/ufscommon.h 12 Jul 2007 01:08:09 -0000 1.9.10.1 +++ squid3/src/fs/ufs/ufscommon.h 12 Jul 2007 04:18:03 -0000 1.9.10.2 @@ -1,6 +1,6 @@ /* - * $Id: ufscommon.h,v 1.9.10.1 2007/07/12 01:08:09 amosjeffries Exp $ + * $Id: ufscommon.h,v 1.9.10.2 2007/07/12 04:18:03 amosjeffries Exp $ * * SQUID Web Proxy Cache http://www.squid-cache.org/ * ---------------------------------------------------------- @@ -50,9 +50,7 @@ class DiskIOModule; -/** - * \ingroup UFS - */ +/// \ingroup UFS class UFSSwapDir : public SwapDir { @@ -150,9 +148,9 @@ #include "RefCount.h" #include "DiskIO/IORequestor.h" -/* UFS dir specific IO calls +/** UFS dir specific IO calls * - * This should be whittled away - DiskIOModule should be providing the + * \todo This should be whittled away - DiskIOModule should be providing the * entire needed api. */ @@ -160,9 +158,7 @@ class DiskFile; -/** - * \ingroup UFS - */ +/// \ingroup UFS class UFSStrategy { @@ -190,26 +186,24 @@ virtual int callback(); - /* Init per-instance logic */ + /** Init per-instance logic */ virtual void init(); - /* cachemgr output on the IO instance stats */ + /** cachemgr output on the IO instance stats */ virtual void statfs(StoreEntry & sentry)const; - /* The io strategy in use */ + /** The io strategy in use */ DiskIOStrategy *io; protected: friend class UFSSwapDir; }; -/* Common ufs-store-dir logic */ +/** Common ufs-store-dir logic */ class ReadRequest; -/** - * \ingroup UFS - */ +/// \ingroup UFS class UFSStoreState : public StoreIOState, public IORequestor { @@ -261,17 +255,17 @@ }; - /* These should be in the IO strategy */ + /** \todo These should be in the IO strategy */ struct { - /* + /** * DPW 2006-05-24 * the write_draining flag is used to avoid recursion inside * the UFSStoreState::drainWriteQueue() method. */ bool write_draining; - /* + /** * DPW 2006-05-24 * The try_closing flag is set by UFSStoreState::tryClosing() * when UFSStoreState wants to close the file, but cannot @@ -298,12 +292,12 @@ void doWrite(); }; +/// \ingroup UFS MEMPROXY_CLASS_INLINE(UFSStoreState::_queued_read) +/// \ingroup UFS MEMPROXY_CLASS_INLINE(UFSStoreState::_queued_write) -/** - * \ingroup UFS - */ +/// \ingroup UFS class StoreSearchUFS : public StoreSearch { @@ -333,9 +327,7 @@ bool _done; }; -/** - * \ingroup UFS - */ +/// \ingroup UFS class RebuildState : public RefCountable { @@ -350,7 +342,7 @@ * or an error occurs */ virtual void next(void (callback)(void *cbdata), void *cbdata); - /* return true if a new StoreEntry is immediately available */ + /** \retval true if a new StoreEntry is immediately available */ virtual bool next(); virtual bool error() const; virtual bool isDone() const;