diff options
author | bea@american.lindenlab.com <bea@american.lindenlab.com> | 2009-12-09 12:52:27 -0800 |
---|---|---|
committer | bea@american.lindenlab.com <bea@american.lindenlab.com> | 2009-12-09 12:52:27 -0800 |
commit | 0bf7917ae848388a3e1bc6ad13e300880fed12d0 (patch) | |
tree | a3cba8d61c0345e57cec09a565a12eccd8b9da39 /indra/llplugin/llpluginsharedmemory.cpp | |
parent | 13eeba25d8573d0bb9ec6d19e5949a676ff546a2 (diff) |
Added Doxygen comments
Diffstat (limited to 'indra/llplugin/llpluginsharedmemory.cpp')
-rw-r--r-- | indra/llplugin/llpluginsharedmemory.cpp | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/indra/llplugin/llpluginsharedmemory.cpp b/indra/llplugin/llpluginsharedmemory.cpp index 3c69a69d28..9c18b410c7 100644 --- a/indra/llplugin/llpluginsharedmemory.cpp +++ b/indra/llplugin/llpluginsharedmemory.cpp @@ -1,6 +1,6 @@ /** * @file llpluginsharedmemory.cpp - * @brief LLPluginSharedMemory manages a shared memory segment for use by the LLPlugin API. + * LLPluginSharedMemory manages a shared memory segment for use by the LLPlugin API. * * @cond * $LicenseInfo:firstyear=2008&license=viewergpl$ @@ -96,6 +96,10 @@ std::string LLPluginSharedMemory::createName(void) return newname.str(); } +/** + * @brief LLPluginSharedMemoryImpl is the platform-dependent implementation of LLPluginSharedMemory. TODO:DOC is this necessary/sufficient? kinda obvious. + * + */ class LLPluginSharedMemoryPlatformImpl { public: @@ -112,6 +116,9 @@ public: }; +/** + * Constructor. Creates a shared memory segment. + */ LLPluginSharedMemory::LLPluginSharedMemory() { mSize = 0; @@ -121,6 +128,9 @@ LLPluginSharedMemory::LLPluginSharedMemory() mImpl = new LLPluginSharedMemoryPlatformImpl; } +/** + * Destructor. Uses destroy() and detach() to ensure shared memory segment is cleaned up. + */ LLPluginSharedMemory::~LLPluginSharedMemory() { if(mNeedsDestroy) |