Generate documentation comments

Generate documentation comments in C++ — with the four heights of help laid out: do it now, make it easier for the next person to accept, work out the right move when you are stuck, and learn the pattern so it stops coming back.

4prompt heights
Open it in the interactive atlas →

The four heights

The same task, four distances: today's deadline, the next reviewer, the stuck moment, the pattern.

Execute — do the immediate task

+
I have a set of public API functions in src/rendering/material.h that other teams will call.…
I have a set of public API functions in src/rendering/material.h that other teams will call. Generate documentation comments above each function and struct that explain what the caller must provide, the function’s side effects, and any performance characteristics (allocation, locking, expected complexity). Use short imperative sentences, mention thread-safety explicitly, and give an example of typical input for each function. Ladder L1

Improve — make it easier to accept

+
Before I commit these comments, make them easy for a graphics engineer reviewing a release note:…
Before I commit these comments, make them easy for a graphics engineer reviewing a release note: surface the return value and error conditions first, make threading guarantees and ownership transfer unmistakable, and flag any parameters that are likely to be misused. Keep comments concise so they fit on a small popup in IDE tooltips. Ladder L2

Decide — diagnose the stuck moment

+
I just changed the doc comments for TextureHandle and some callers now assume ownership is…

I edited comments but CI flagged inconsistent wording about ownership

I just changed the doc comments for TextureHandle and some callers now assume ownership is transferred; the build checks failed because my wording is inconsistent. I'm worried the wrong teams will adopt the wrong convention. What's the most likely misunderstanding from my current phrasing, and how should I rewrite the key sentence to make ownership explicit? Ladder L5

Become — change the pattern

+
Over several releases, our inline comments slowly stop matching actual ownership, thread-safety and…

Docs drift from implementation over releases

Over several releases, our inline comments slowly stop matching actual ownership, thread-safety and error behavior. Where do we keep losing accuracy in our documentation, and what habit should we adopt to keep comments truthful? Recommend one short process change, one CI guard, and one example template for doc comments that developers can follow. Ladder L6

Next to this one

Other programming language work people do in C++.

Every task here came from the work, not from a feature list — which is why the prompts name what you want done and never the button that does it. The tool changes; the work does not.
Copyright © LLOS.ai · 2026 — original pedagogy, voice, and design — all rights reserved.

The rest of the map

Same library, five ways in.