Differential D57056

net80211: add some example doxygen inline documents
ClosedPublic
Actions

Authored by adrian on Sun, May 17, 6:47 PM.

Details

Reviewers

None

Group Reviewers

wireless

Commits

rG0c37c9928c68: net80211: add some example doxygen inline documents

Summary

This isn't supposed to be comprehensive, I want to have examples
for the common doxygen comments:

describing a struct
inside a struct - single line before the item
inside a struct - same line after an item
inside a struct - multi-line before an item

These build fine with the doxygen build in tools/kerneldoc/subsys/ .

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

adrian created this revision.Sun, May 17, 6:47 PM

Herald added subscribers: glebius, melifaro, imp. · View Herald TranscriptSun, May 17, 6:47 PM

adrian requested review of this revision.Sun, May 17, 6:47 PM

Harbormaster completed remote builds in B73170: Diff 177979.Sun, May 17, 6:47 PM

adrian added a child revision: D56760: net80211: add initial README.md and PROTOCOL.md.Sun, May 17, 6:48 PM

adrian added a parent revision: D57055: net80211: create ieee80211_ht_check_bar_exceed_retry_count().

adrian added a reviewer: wireless.Sun, May 17, 6:56 PM

adrian added a project: wireless.

adrian added a child revision: D57079: net80211: update/add some VHT doxygen documentation.Tue, May 19, 5:10 AM

adrian removed a child revision: D56760: net80211: add initial README.md and PROTOCOL.md.

This revision was not accepted when it landed; it landed in state Needs Review.Mon, May 25, 1:34 AM

Closed by commit rG0c37c9928c68: net80211: add some example doxygen inline documents (authored by adrian). · Explain Why

This revision was automatically updated to reflect the committed changes.

adrian added a commit: rG0c37c9928c68: net80211: add some example doxygen inline documents.

Revision Contents
Changeset List

Path

Size

sys/

net80211/

ieee80211_var.h

29 lines

Diff 178535

View Options

sys/net80211/ieee80211_var.h

net80211: add some example doxygen inline documentsClosedPublicActions