From 8c5d7f7deae36b71c1d13e4edc877ba8e35d3acf Mon Sep 17 00:00:00 2001 From: Wouter van Oortmerssen Date: Mon, 18 Aug 2014 13:49:00 -0700 Subject: [PATCH] Clarified a documentation statement about circular references. Change-Id: I8f3c50085f89037995ab9f26b28d3c83667e9d6f --- docs/html/md__internals.html | 2 +- docs/source/Internals.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/html/md__internals.html b/docs/html/md__internals.html index e277beb..b4da59f 100644 --- a/docs/html/md__internals.html +++ b/docs/html/md__internals.html @@ -107,7 +107,7 @@ inline const char **EnumNamesAny() { inline const char *EnumNameAny(int e) { return EnumNamesAny()[e]; }

Unions share a lot with enums.

struct Vec3;
 struct Monster;
-

Predeclare all datatypes since there may be circular references.

MANUALLY_ALIGNED_STRUCT(4) Vec3 {
+

Predeclare all data types since circular references between types are allowed (circular references between object are not, though).

MANUALLY_ALIGNED_STRUCT(4) Vec3 {
  private:
   float x_;
   float y_;
diff --git a/docs/source/Internals.md b/docs/source/Internals.md
index afe994f..bf4b58b 100755
--- a/docs/source/Internals.md
+++ b/docs/source/Internals.md
@@ -159,7 +159,8 @@ Unions share a lot with enums.
     struct Vec3;
     struct Monster;
 
-Predeclare all datatypes since there may be circular references.
+Predeclare all data types since circular references between types are allowed
+(circular references between object are not, though).
 
     MANUALLY_ALIGNED_STRUCT(4) Vec3 {
      private:
-- 
2.7.4