Skip to content

Add documentation to libspdl public APIs#1237

Merged
meta-codesync[bot] merged 1 commit intomainfrom
export-D88662214
Dec 9, 2025
Merged

Add documentation to libspdl public APIs#1237
meta-codesync[bot] merged 1 commit intomainfrom
export-D88662214

Conversation

@moto-meta
Copy link
Copy Markdown
Contributor

Summary:
Facebook

Instructions about RACER Diffs:

Commandeer this diff (recommended) or land with accept2ship tag.

This diff was generated by Racer AI agent on behalf of Moto Hira for T247855909. If the diff quality is poor, consider contacting the user to provide clearer instructions on the task.

  • If you are happy with the changes, commandeer it if minor edits are needed. (we encourage commandeer to get the diff credit)
  • If you are not happy with the changes, please comment on the diff with clear actions and send it back to the author. Racer will pick it up and re-generate.
  • If you really feel the Racer is not helping with this change (alas, some complex changes are hard for AI) feel free to abandon this diff.
  • For M10N reviewers: as you review AI-generated diffs, we ask you to give them the same priority as human-generated diffs, and take action in a timely manner by either accepting, rejecting, or resigning as a reviewer. For diffs that don't meet the quality bar (e.g. code doesn't compile, not readable or introduces functionality regressions), we ask that you use the following hashtags to provide clear signals to improve our tools - #monlowqualitydiff #monwrongreviewerdiff

Summary:

Added Doxygen-style documentation to all public APIs in fbcode/libspdl/core/.h and fbcode/libspdl/cuda/.h header files.

Changes:

  • Documented 17 core header files with class, struct, enum, and function documentation
  • Documented 6 CUDA header files with documentation for GPU operations
  • Used Doxygen comment style (///) for consistency
  • Included parameter descriptions, return values, and brief descriptions for all public APIs
  • Excluded detail namespace as requested

Generated by RACER, powered by Confucius
Session, Trace
Session, Trace

Differential Revision: D88662214

Summary:
Facebook

## Instructions about RACER Diffs:
**Commandeer this diff (recommended) or land with accept2ship tag.**

**This diff was generated by Racer AI agent on behalf of [Moto Hira](https://www.internalfb.com/profile/view/100011173574054) for T247855909. If the diff quality is poor, consider contacting the user to provide clearer instructions on the task.**

- If you are happy with the changes, commandeer it if minor edits are needed. (**we encourage commandeer to get the diff credit**)
- If you are not happy with the changes, please comment on the diff with clear actions and send it back to the author. Racer will pick it up and re-generate.
- If you really feel the Racer is not helping with this change (alas, some complex changes are hard for AI) feel free to abandon this diff.
- **For M10N reviewers:** as you review AI-generated diffs, we ask you to give them the same priority as human-generated diffs, and take action in a timely manner by either accepting, rejecting, or resigning as a reviewer. For diffs that don't meet the quality bar (e.g. code doesn't compile, not readable or introduces functionality regressions), we ask that you use the following hashtags to provide clear signals to improve our tools - `#monlowqualitydiff` `#monwrongreviewerdiff`

## Summary:
Added Doxygen-style documentation to all public APIs in fbcode/libspdl/core/*.h and fbcode/libspdl/cuda/*.h header files.

**Changes:**
- Documented 17 core header files with class, struct, enum, and function documentation
- Documented 6 CUDA header files with documentation for GPU operations
- Used Doxygen comment style (///) for consistency
- Included parameter descriptions, return values, and brief descriptions for all public APIs
- Excluded detail namespace as requested

---
> Generated by [RACER](https://www.internalfb.com/wiki/RACER_(Risk-Aware_Code_Editing_and_Refactoring)/), powered by [Confucius](https://www.internalfb.com/wiki/Confucius/Analect/Shared_Analects/Confucius_Code_Assist_(CCA)/)
[Session](https://www.internalfb.com/confucius?session_id=6e726124-d469-11f0-a070-a9b845a3c5bc&tab=Chat), [Trace](https://www.internalfb.com/confucius?session_id=6e726124-d469-11f0-a070-a9b845a3c5bc&tab=Trace)
[Session](https://www.internalfb.com/confucius?session_id=9f001fb2-d512-11f0-aa32-db8943b998ac&tab=Chat), [Trace](https://www.internalfb.com/confucius?session_id=9f001fb2-d512-11f0-aa32-db8943b998ac&tab=Trace)

Differential Revision: D88662214
@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Dec 9, 2025
@meta-codesync
Copy link
Copy Markdown
Contributor

meta-codesync bot commented Dec 9, 2025

@moto-meta has exported this pull request. If you are a Meta employee, you can view the originating Diff in D88662214.

@meta-codesync meta-codesync bot merged commit edd59a8 into main Dec 9, 2025
108 checks passed
@mthrok mthrok deleted the export-D88662214 branch December 10, 2025 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot. fb-exported meta-exported

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant