Documentation|libdeng2: API doc cleanup

Copyright marks and class/file grouping.
skyjake · Feb 21, 2014 · 4f02c51 · 4f02c51
1 parent 19d1ecc
commit 4f02c51
Show file tree

Hide file tree

Showing 278 changed files with 320 additions and 379 deletions.
diff --git a/doomsday/libdeng2/include/de/c_wrapper.h b/doomsday/libdeng2/include/de/c_wrapper.h
@@ -1,7 +1,7 @@
-/*
- * The Doomsday Engine Project -- libdeng2
+/** @file c_wrapper.h  C wrapper for various libdeng2 classes.
+ * @ingroup core
  *
- * Copyright (c) 2011-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2011-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/charsymbols.h b/doomsday/libdeng2/include/de/charsymbols.h
@@ -1,6 +1,6 @@
 /** @file charsymbols.h  Character (Unicode) symbols.
  *
- * @authors Copyright (c) 2014 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2014 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/concurrency/guard.h b/doomsday/libdeng2/include/de/concurrency/guard.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2011-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2011-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/concurrency/lockable.h b/doomsday/libdeng2/include/de/concurrency/lockable.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/concurrency/readwritelockable.h b/doomsday/libdeng2/include/de/concurrency/readwritelockable.h
@@ -1,6 +1,6 @@
 /** @file readwritelockable.h  Read-write lock.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/concurrency/task.h b/doomsday/libdeng2/include/de/concurrency/task.h
@@ -1,6 +1,6 @@
 /** @file task.h  Concurrent task.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/concurrency/taskpool.h b/doomsday/libdeng2/include/de/concurrency/taskpool.h
@@ -1,6 +1,6 @@
 /** @file taskpool.h  Pool of tasks.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/concurrency/waitable.h b/doomsday/libdeng2/include/de/concurrency/waitable.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/app.h b/doomsday/libdeng2/include/de/core/app.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2010-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2010-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/asset.h b/doomsday/libdeng2/include/de/core/asset.h
@@ -1,6 +1,6 @@
 /** @file asset.h  Information about the state of an asset (e.g., resource).
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html
@@ -35,6 +35,8 @@ namespace de {
  * OpenGL shader may or may not be compiled and ready to be used, but a native
  * file in the FileSystem is always considered available (as it can be read via
  * the native file system at any time).
+ *
+ * @ingroup core
  */
 class DENG2_PUBLIC Asset
 {
@@ -81,6 +83,8 @@ class DENG2_PUBLIC Asset
  * AssetGroup is derived from Asset so it is possible to group assets
  * together and depend on the groups as a whole.
  *
+ * @ingroup core
+ *
  * @todo Any better name for this class?
  */
 class DENG2_PUBLIC AssetGroup : public Asset,

diff --git a/doomsday/libdeng2/include/de/core/clock.h b/doomsday/libdeng2/include/de/core/clock.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/commandline.h b/doomsday/libdeng2/include/de/core/commandline.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/config.h b/doomsday/libdeng2/include/de/core/config.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html
@@ -44,6 +44,8 @@ class ArrayValue;
  * In practice, Config is a specialized script namespace stored in a Record. It gets
  * written to the application's persistent data store (persist.pack) using a Refuge. The
  * Config is automatically written persistently before being destroyed.
+ *
+ * @ingroup core
  */
 class DENG2_PUBLIC Config
 {

diff --git a/doomsday/libdeng2/include/de/core/debuglogsink.h b/doomsday/libdeng2/include/de/core/debuglogsink.h
@@ -26,6 +26,7 @@
 namespace de {
 
 /**
+ * Log sink that uses QDebug for output.
  * @ingroup core
  */
 class DebugLogSink : public LogSink

diff --git a/doomsday/libdeng2/include/de/core/event.h b/doomsday/libdeng2/include/de/core/event.h
@@ -26,7 +26,7 @@ namespace de {
 /**
  * Base class for events.
  *
- * @ingroup widgets
+ * @ingroup core
  */
 class DENG2_PUBLIC Event
 {

diff --git a/doomsday/libdeng2/include/de/core/garbage.h b/doomsday/libdeng2/include/de/core/garbage.h
@@ -68,7 +68,7 @@ DENG2_PUBLIC int Garbage_IsTrashed(void const *ptr);
  * @warning Do not call this if there is a chance that the pointer has already
  * been freed.
  *
- * @param ptr  Pointer to memory allocated from the @ref memzone.
+ * @param ptr  Pointer to memory previously put in the trash.
  */
 DENG2_PUBLIC void Garbage_Untrash(void *ptr);
 

diff --git a/doomsday/libdeng2/include/de/core/highperformancetimer.h b/doomsday/libdeng2/include/de/core/highperformancetimer.h
@@ -1,6 +1,6 @@
 /** @file highperformancetimer.h  Timer for performance-critical use.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html
@@ -25,6 +25,7 @@ namespace de {
 
 /**
  * Timer for high-performance use.
+ * @ingroup core
  */
 class DENG2_PUBLIC HighPerformanceTimer
 {

diff --git a/doomsday/libdeng2/include/de/core/id.h b/doomsday/libdeng2/include/de/core/id.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html
@@ -32,6 +32,7 @@ class String;
 /**
  * Unique identifier number. Zero is not a valid identifier, as it reserved
  * for the "no identifier" special case.
+ * @ingroup core
  */
 class DENG2_PUBLIC Id : public ISerializable, public LogEntry::Arg::Base
 {

diff --git a/doomsday/libdeng2/include/de/core/library.h b/doomsday/libdeng2/include/de/core/library.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/log.h b/doomsday/libdeng2/include/de/core/log.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/logbuffer.h b/doomsday/libdeng2/include/de/core/logbuffer.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/logfilter.h b/doomsday/libdeng2/include/de/core/logfilter.h
@@ -1,6 +1,6 @@
 /** @file logfilter.h  Log entry filter.
  *
- * @authors Copyright (c) 2014 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2014 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/loop.h b/doomsday/libdeng2/include/de/core/loop.h
@@ -1,6 +1,6 @@
 /** @file loop.h  Continually triggered loop.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/memorylogsink.h b/doomsday/libdeng2/include/de/core/memorylogsink.h
@@ -1,6 +1,6 @@
 /** @file memorylogsink.h  Log sink that stores log entries in memory.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html
@@ -28,6 +28,7 @@ namespace de {
 
 /**
  * Log sink that stores log entries in memory.
+ * @ingroup core
  */
 class DENG2_PUBLIC MemoryLogSink : public LogSink, public Lockable
 {

diff --git a/doomsday/libdeng2/include/de/core/range.h b/doomsday/libdeng2/include/de/core/range.h
@@ -1,6 +1,6 @@
 /** @file range.h  Linear range.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html
@@ -31,6 +31,8 @@ namespace de {
 /**
  * Linear value range. The start point is inclusive while the end point is
  * exclusive. The end point should be larger in value than the start point.
+ *
+ * @ingroup math
  */
 template <typename Type>
 struct Range

diff --git a/doomsday/libdeng2/include/de/core/rectangle.h b/doomsday/libdeng2/include/de/core/rectangle.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/system.h b/doomsday/libdeng2/include/de/core/system.h
@@ -1,6 +1,6 @@
 /** @file system.h  Base class for application subsystems.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/core/unixinfo.h b/doomsday/libdeng2/include/de/core/unixinfo.h
@@ -41,6 +41,8 @@ namespace de {
  * Mac OS X, ~/Library/Preferences/) but these are not directly used by
  * libdeng2. Instead of these, one should use Config (or QSettings) for
  * platform-independent persistent configuration.
+ *
+ * @ingroup core
  */
 class UnixInfo
 {

diff --git a/doomsday/libdeng2/include/de/core/version.h b/doomsday/libdeng2/include/de/core/version.h
@@ -2,8 +2,8 @@
  * @file version.h
  * Version numbering and labeling for libdeng2.
  *
- * @authors Copyright &copy; 2011-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
- * @authors Copyright &copy; 2011-2013 Daniel Swanson <danij@dengine.net>
+ * @authors Copyright © 2011-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2011-2013 Daniel Swanson <danij@dengine.net>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html
@@ -38,6 +38,8 @@ namespace de {
  * switches to major version 2, libdeng2 version will be synced with the rest
  * of the project. Also note that unlike libdeng1, there is only ever three
  * components in the version (or four, counting the build number).
+ *
+ * @ingroup core
  */
 class DENG2_PUBLIC Version
 {

diff --git a/doomsday/libdeng2/include/de/data/accessorvalue.h b/doomsday/libdeng2/include/de/data/accessorvalue.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2009-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/data/archive.h b/doomsday/libdeng2/include/de/data/archive.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/data/arrayvalue.h b/doomsday/libdeng2/include/de/data/arrayvalue.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/data/bank.h b/doomsday/libdeng2/include/de/data/bank.h
@@ -1,6 +1,6 @@
 /** @file bank.h  Abstract data bank with multi-tiered caching.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/data/bitfield.h b/doomsday/libdeng2/include/de/data/bitfield.h
@@ -1,6 +1,6 @@
 /** @file bitfield.h  Array of integers packed together.
  *
- * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html
@@ -29,6 +29,8 @@ namespace de {
 
 /**
  * Array of integer values packed tightly together.
+ *
+ * @ingroup data
  */
 class DENG2_PUBLIC BitField
 {

diff --git a/doomsday/libdeng2/include/de/data/block.h b/doomsday/libdeng2/include/de/data/block.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html

diff --git a/doomsday/libdeng2/include/de/data/blockvalue.h b/doomsday/libdeng2/include/de/data/blockvalue.h
@@ -1,7 +1,7 @@
 /*
  * The Doomsday Engine Project -- libdeng2
  *
- * Copyright (c) 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * Copyright © 2004-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
  * @par License
  * LGPL: http://www.gnu.org/licenses/lgpl.html