Debug doc generation

[timmoon10]

Description

This PR fixes some Doxygen warnings and LaTeX errors.

Type of change

• Documentation change (change only to the documentation, either a fix or a new content)
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Infra/Build change
• Code refactoring

Changes

• Fix Doxygen warnings and a LaTeX error

Checklist:

• I have read and followed the contributing guidelines
• The functionality is complete
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[timmoon10]

\text requires amsmath.

[greptile-apps]

Greptile Summary

Fixed Doxygen documentation warnings and LaTeX compilation errors across header files in the TransformerEngine C API.

• Corrected parameter name mismatches between function signatures and documentation comments (e.g., workplace → workspace, gated_act_input → act_input, cu_seqlen → cu_seqlens)
• Added missing parameter documentation (num_tensors, scaling_mode, stream, dim, t)
• Fixed LaTeX formula syntax in recipe.h by escaping underscores and correcting subscript formatting (@f$ 2^{-margin} \max_{fp8_dtype} @f$)
• Updated file header comment to match actual filename in cast_transpose_noop.h
• Added documentation for move constructors/operators and struct members
• Removed obsolete deterministic parameter documentation
• Added *.DS_Store to .gitignore for macOS system files

All changes are documentation-only fixes with no functional code modifications.

Confidence Score: 5/5

• This PR is completely safe to merge with zero risk
• All changes are documentation-only fixes (Doxygen comments and LaTeX formulas) with no modifications to actual code logic or behavior. The fixes correct parameter name mismatches, add missing documentation, and resolve compilation warnings, improving the quality and accuracy of generated documentation
• No files require special attention

Important Files Changed

Filename	Overview
transformer_engine/common/include/transformer_engine/cast.h	Fixed parameter name typo (workplace to workspace), corrected spacing, and added missing num_tensors parameter documentation
transformer_engine/common/include/transformer_engine/normalization.h	Improved documentation format for function parameters, added missing doc for nvte_enable_cudnn_norm_bwd, and added doc for NVTE_Norm_Type enum
transformer_engine/common/include/transformer_engine/recipe.h	Fixed LaTeX formula syntax for proper rendering (underscores escaped, formatting corrected)
transformer_engine/common/include/transformer_engine/transformer_engine.h	Added struct member docs, fixed parameter names in multiple places, corrected return value docs, and added missing scaling_mode parameter docs
transformer_engine/common/include/transformer_engine/transpose.h	Fixed parameter name inconsistency (gated_act_input to act_input) across multiple functions to match actual parameter names

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Dox as Doxygen
    participant LaTeX as LaTeX Compiler
    participant Doc as Documentation Output

    Note over Dev,Doc: Documentation Generation Process

    Dev->>Dox: Generate docs from header files
    activate Dox
    
    Note over Dox: Before PR: Parse header files
    Dox-->>Dev: ⚠️ Warnings (param name mismatches)
    Dox-->>Dev: ⚠️ Warnings (missing param docs)
    Dox-->>Dev: ⚠️ Warnings (file comment mismatch)
    
    Dox->>LaTeX: Generate LaTeX for formulas
    activate LaTeX
    
    Note over LaTeX: Before PR: Process LaTeX
    LaTeX-->>Dev: ❌ Errors (invalid LaTeX syntax in recipe.h)
    deactivate LaTeX
    deactivate Dox
    
    Note over Dev: Apply PR fixes:<br/>- Fix param name typos<br/>- Add missing param docs<br/>- Fix LaTeX formulas<br/>- Update file comments

    Dev->>Dox: Regenerate docs with fixes
    activate Dox
    
    Note over Dox: After PR: Parse corrected headers
    Dox->>Dox: Validate parameter names match
    Dox->>Dox: Verify all params documented
    
    Dox->>LaTeX: Generate corrected LaTeX
    activate LaTeX
    LaTeX->>LaTeX: Parse fixed formulas
    LaTeX-->>Dox: ✓ Success
    deactivate LaTeX
    
    Dox->>Doc: Generate clean documentation
    Dox-->>Dev: ✓ No warnings
    deactivate Dox
    
    Doc-->>Dev: Clean documentation output

Loading

[timmoon10]

/te-ci core