瀏覽代碼

Put hash, multi_hash and event_stream namespaces in Containers documentation module

Daniele Bartolini 12 年之前
父節點
當前提交
7dd22ed003
共有 2 個文件被更改,包括 10 次插入1 次删除
  1. 5 1
      engine/core/containers/EventStream.h
  2. 5 0
      engine/core/containers/Hash.h

+ 5 - 1
engine/core/containers/EventStream.h

@@ -37,8 +37,12 @@ namespace crown
 /// @ingroup Containers
 /// @ingroup Containers
 typedef Array<char> EventStream;
 typedef Array<char> EventStream;
 
 
-/// Functions for operating on a Array<char> as a stream of events of the form:
+/// Functions to manipulate EventStream.
+///
+/// The events are stored in the following form:
 /// [event_header_0][event_data_0][event_header_1][event_data_1] ...
 /// [event_header_0][event_data_0][event_header_1][event_data_1] ...
+///
+/// @ingroup Containers
 namespace event_stream
 namespace event_stream
 {
 {
 	struct Header
 	struct Header

+ 5 - 0
engine/core/containers/Hash.h

@@ -35,6 +35,8 @@ namespace crown {
 	///
 	///
 	/// When items are removed, the array-list is repacked to always keep
 	/// When items are removed, the array-list is repacked to always keep
 	/// it tightly ordered.
 	/// it tightly ordered.
+	///
+	/// @ingroup Containers
 	namespace hash
 	namespace hash
 	{
 	{
 		/// Returns true if the specified key exists in the hash.
 		/// Returns true if the specified key exists in the hash.
@@ -63,6 +65,9 @@ namespace crown {
 		template<typename T> const typename Hash<T>::Entry *end(const Hash<T> &h);
 		template<typename T> const typename Hash<T>::Entry *end(const Hash<T> &h);
 	}
 	}
 
 
+	/// Functions to manipulate Hash as a multi-hash.
+	///
+	/// @ingroup Containers
 	namespace multi_hash
 	namespace multi_hash
 	{
 	{
 		/// Finds the first entry with the specified key.
 		/// Finds the first entry with the specified key.