PixarAnimationStudios / OpenUSD

Universal Scene Description
http://www.openusd.org
Other
6.14k stars 1.22k forks source link

[Docs] Schema class docs, Kind glossary entry, mention of Private _Apply() #1379

Open rlei-weta opened 4 years ago

rlei-weta commented 4 years ago

USD/pxr/usd/lib/usd is outdated:

Mention of removed private _Apply():

"pusblished":

This next one is more of a suggestion - in the Note section of https://graphics.pixar.com/usd/docs/api/_usd__page__generating_schemas.html#Usd_SchemaCodeGeneration, moduleDeps.cpp also deserves a mention that it is not auto-genned nor updated.  At first glance it may seem like a boilerplate file due to its presence in all of the schema libraries.  

Furthermore, moduleDeps.cpp also deserves a separate mention that it is meant to be built as part of the C++ library as opposed to the python module. We made this mistake before understanding the purpose of it - as did a another facility. It was fairly subtle until we hit a particular use case :smile:

An excerpt about its exact contribution to the runtime would go wonders!

jilliene commented 4 years ago

Filed as internal issue #USD-6464

spiffmon commented 4 years ago

I've addressed the non-doxygen related issues, and pushed out the results. The section in the schema generation tutorial was much more grievously out of date than you noted, and I think I've patched it all up.

Thanks, @rlei-weta , I'll leave this open for the doxygen issues.