Skip to content

Commit

Permalink
Clarify some ArResolver documentation.
Browse files Browse the repository at this point in the history
(Internal change: 1661264)
  • Loading branch information
spiffmon authored and pixar-oss committed Oct 17, 2016
1 parent 7bad1b0 commit 1b23636
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions pxr/usd/lib/ar/resolver.h
Original file line number Diff line number Diff line change
Expand Up @@ -134,33 +134,35 @@ class AR_API ArResolver
/// @}

// --------------------------------------------------------------------- //
/// \name Layer-specific Operations
/// \name File/asset-specific Operations
///
/// \see SdfLayer
/// @{
// --------------------------------------------------------------------- //

/// Returns the resolved filesystem path for the layer identified
/// Returns the resolved filesystem path for the file identified
/// by \p path following the same path resolution behavior as in
/// \ref Resolve(const std::string&).
///
/// If the layer identified by \p path represents an asset and
/// \p assetInfo is not \c nullptr, it will be populated with
/// additional information about the asset.
/// If the file identified by \p path represents an asset and
/// \p assetInfo is not \c nullptr, the resolver should populate
/// \p assetInfo with whatever additional metadata it knows or can
/// reasonably compute about the asset without actually opening it.
///
/// \see Resolve(const std::string&).
virtual std::string ResolveWithAssetInfo(
const std::string& path,
ArAssetInfo* assetInfo) = 0;

/// Update \p assetInfo with respect to the given \p fileVersion
/// Update \p assetInfo with respect to the given \p fileVersion .
/// \note This API is currently in flux. In general, you should prefer
/// to call ResolveWithAssetInfo()
virtual void UpdateAssetInfo(
const std::string& identifier,
const std::string& filePath,
const std::string& fileVersion,
ArAssetInfo* assetInfo) = 0;

/// Returns true if a layer may be written to the given \p path, false
/// Returns true if a file may be written to the given \p path, false
/// otherwise.
///
/// If this function returns false and \p whyNot is not \c nullptr,
Expand All @@ -169,7 +171,7 @@ class AR_API ArResolver
const std::string& path,
std::string* whyNot) = 0;

/// Returns true if a new layer may be created using the given
/// Returns true if a new file may be created using the given
/// \p identifier, false otherwise.
///
/// If this function returns false and \p whyNot is not \c nullptr,
Expand Down

0 comments on commit 1b23636

Please sign in to comment.