Move value clips documentation to separate page

Unsurprisingly, advanced features tend to need more documentation, so moving them to their own pages makes things easier to read. Fixed up references to the value clips documentation in other code as well. (Internal change: 1733138)
PixarAnimationStudios · Apr 5, 2017 · 9438cf2 · 9438cf2
1 parent 399bb74
commit 9438cf2
Show file tree

Hide file tree

Showing 9 changed files with 501 additions and 500 deletions.
diff --git a/pxr/usd/lib/usd/clipsAPI.h b/pxr/usd/lib/usd/clipsAPI.h
@@ -94,7 +94,7 @@ class SdfAssetPath;
 /// will provide the topology and unvarying data for the model, while           
 /// the clips will provide the time-sampled animation.
 /// 
-/// For further information, see \ref Usd_AdvancedFeatures_ClipsOverview 
+/// For further information, see \ref Usd_Page_ValueClips
 /// 
 ///
 class UsdClipsAPI : public UsdSchemaBase

diff --git a/pxr/usd/lib/usd/doxygen/advancedFeatures.dox b/pxr/usd/lib/usd/doxygen/advancedFeatures.dox
diff --git a/pxr/usd/lib/usd/doxygen/front.dox b/pxr/usd/lib/usd/doxygen/front.dox
@@ -66,10 +66,6 @@ import/export.
      <li> \ref Usd_AssetResolution </li>
      </ol>
 <li> \subpage Usd_Page_AdvancedFeatures </li>
-     <ol type="i">
-     <li> \ref Usd_ExplicitInstancing </li>
-     <li> \ref Usd_AdvancedFeatures_ClipsOverview </li>
-     </ol>
 <li> \subpage Usd_Page_AuthoringEditing </li>
      <ol type="i">
      <li> \ref Usd_SelectiveEditing </li>

diff --git a/pxr/usd/lib/usd/doxygen/objectModel.dox b/pxr/usd/lib/usd/doxygen/objectModel.dox
@@ -204,7 +204,7 @@ layer just as UsdAttribute values can be, \em within a given layer, a metadatum
 can have only a single value - i.e. it cannot be sampled over time.  Removing
 time as an axis of variation allows metadata to be evaluated and stored more
 efficiently than attribute values, and also means that metadata authored in
-\ref Usd_AdvancedFeatures_ClipsOverview "Value Clips" will be ignored by USD.
+\ref Usd_Page_ValueClips "Value Clips" will be ignored by USD.
 
 \li *Core metadata resolution rules vary.* 
 \ref Usd_ValueResolution "Attribute Value Resolution" is fixed for all

diff --git a/pxr/usd/lib/usd/doxygen/valueClips.dox b/pxr/usd/lib/usd/doxygen/valueClips.dox
diff --git a/pxr/usd/lib/usd/generatedSchema.usda b/pxr/usd/lib/usd/generatedSchema.usda
@@ -69,7 +69,7 @@ class "ClipsAPI" (
     will provide the topology and unvarying data for the model, while           
     the clips will provide the time-sampled animation.
 
-    For further information, see 
+    For further information, see \\ref Usd_Page_ValueClips
     """
 )
 {

diff --git a/pxr/usd/lib/usd/schema.usda b/pxr/usd/lib/usd/schema.usda
@@ -191,7 +191,7 @@ class "ClipsAPI"
     will provide the topology and unvarying data for the model, while           
     the clips will provide the time-sampled animation.
 
-    For further information, see \\ref Usd_AdvancedFeatures_ClipsOverview 
+    For further information, see \\ref Usd_Page_ValueClips
     """
 )
 {

diff --git a/pxr/usd/lib/usd/stage.h b/pxr/usd/lib/usd/stage.h
@@ -892,7 +892,7 @@ class UsdStage : public TfRefBase, public TfWeakBase {
     /// if it has one. If \a includeClipLayers is true, we will also include
     /// all of the layers that this stage has had to open so far to perform
     /// value resolution of attributes affected by 
-    /// \ref Usd_AdvancedFeatures_ClipsOverview "Value Clips"
+    /// \ref Usd_Page_ValueClips "Value Clips"
     USD_API
     SdfLayerHandleVector GetUsedLayers(bool includeClipLayers=true) const;
 

diff --git a/pxr/usd/lib/usdUtils/stitchClips.h b/pxr/usd/lib/usdUtils/stitchClips.h
@@ -28,7 +28,7 @@
 ///
 /// Collection of utilities for sequencing multiple layers each holding
 /// sequential time-varying data into
-/// \ref Usd_AdvancedFeatures_ClipsOverview "USD Value Clips".
+/// \ref Usd_Page_ValueClips "USD Value Clips".
 
 #include "pxr/pxr.h"
 #include "pxr/usd/usdUtils/api.h"
@@ -41,7 +41,7 @@ PXR_NAMESPACE_OPEN_SCOPE
 SDF_DECLARE_HANDLES(SdfLayer);
 
 /// A function that creates layers that use
-/// \ref Usd_AdvancedFeatures_ClipsOverview "USD Value Clips"
+/// \ref Usd_Page_ValueClips "USD Value Clips"
 /// to effectively merge the time samples in the given \p clipLayers under \p
 /// clipPath without copying the samples into a separate layer.
 ///