slang Stdlib: Fill descriptions for stdlib Builtin interfaces

Currently the doc generation tool reports that 682 descriptions are missing, which is about 86%.

We need to fill in the descriptions preferably in a priority order.

We need clear descriptions for interface, because interfaces don't have implementations and they are nothing without documentation.

Oct 15 '24 19:10 jkwak-work

I am leaving related links for this task.

HTML result page: https://shader-slang.com/stdlib-reference/interfaces/index.html Undocumented items: https://github.com/shader-slang/stdlib-reference/blob/main/summary.txt

Oct 22 '24 17:10 jkwak-work

Currently following items need to be documented,

[ ] IArithmetic.add
[ ] IArithmetic.div
[ ] IArithmetic.mod
[ ] IArithmetic.mul
[ ] IArithmetic.neg
[ ] IArithmetic.sub
[ ] IArray<T>.subscript
[ ] IBufferDataLayout
[ ] IDefaultInitializable.init
[ ] IDifferentiable.dadd
[ ] IDifferentiable.dmul<T>
[ ] IDifferentiable.dzero
[ ] IDifferentiableFunc<TR, each TP>
[ ] IDifferentiableFunc<TR, each TP>.operator()
[ ] IDifferentiableMutatingFunc<TR, each TP>
[ ] IDifferentiableMutatingFunc<TR, each TP>.operator()
[ ] IDifferentiablePtrType
[ ] IFunc<TR, each TP>
[ ] IFunc<TR, each TP>.operator()
[ ] IInteger.init
[ ] IInteger.toInt
[ ] IInteger.toInt64
[ ] IInteger.toUInt
[ ] IInteger.toUInt64
[ ] ILogical.and
[ ] ILogical.bitAnd
[ ] ILogical.bitNot
[ ] ILogical.bitOr
[ ] ILogical.bitXor
[ ] ILogical.init
[ ] ILogical.not
[ ] ILogical.or
[ ] ILogical.shl
[ ] ILogical.shr
[ ] IMutatingFunc<TR, each TP>
[ ] IMutatingFunc<TR, each TP>.operator()
[ ] IRWArray<T>.subscript
[ ] IRangedValue.maxValue
[ ] IRangedValue.minValue

Oct 22 '24 18:10 jkwak-work

@bmillsNV , am I allowed to use Coverall for stdlib documentation? I gave a try and it worked very well, but I like to double check if I am allowed to use it for Slang.

Oct 22 '24 19:10 jkwak-work

@jkwak-work yes you can use coveralls here.

Oct 22 '24 19:10 bmillsNV