[Documentation]: Add documentation to the Effect classes #8276
Conversation
|
Made a few corrections directly to speed up the review. @Maniekko I've accepted this, but can we please avoid the "monkey see monkey do" style of notation in the future, for example: /// <summary>
/// Gets the row count of this effect annotation.
/// </summary>
public int RowCount {get; private set;}To a lay person, what would this even mean, what is a row and why is the count important? There were a few of these. And the style guide has a specific note against just spelling out the name of a parameter |
|
|
||
|
|
||
| /// <summary> | ||
| /// Creates a clone of the <see cref="Effect"/>. |
There was a problem hiding this comment.
Would it be helpful to know what kind of clone? A shallow one (just the Effect properties) or does it do a deep clone? That might be too much info.
| /// <remarks> | ||
| /// For most purposes, this type can be ignored, and treated exactly like a regular effect. | ||
| /// When an EffectMaterial type is loaded from .xnb format, its parameter values and textures | ||
| /// are also loaded and automatically set on the effect, in addition to the HLSL shader code. |
There was a problem hiding this comment.
We might want to remove the reference to HLSL here. by the time the Effect is being used the onderlying shader will be platform specific , e.g GLSL HLSL, metal etc.
|
@Maniekko can you look to see if you can address @dellis1972 comments above, looking to get all these merged this week |
This PR adds the documentation for the following classes in the
Graphicsnamespace:EffectEffectPassEffectAnnotationEffectParameterEffectTechniqueEffectMaterialIEffectMatrices(interface) (added 1 hour later)Notes
One of the doclines in
EffectMaterialrefers toEffectMaterialContentclass, which is only available on DirectX.Reference:
Feature Request: Resolve Missing XML For Public Type Warnings