docs: add annotated wxFrame constructor example to reference (PR #26643)

4 views
Skip to first unread message

sargonkadnezar

unread,
4:21 AM (7 hours ago) 4:21 AM
to wx-...@googlegroups.com, Subscribed

What & Why
New contributors often find the wxFrame constructor's 7 parameters hard to
parse from the reference docs alone. This adds a small, annotated code
snippet directly in the constructor documentation so beginners can see
all parameters at a glance with inline explanations.

Changes

  • interface/wx/frame.h: added @code example to the wxFrame constructor
    doc block showing all 7 parameters with terse inline comments.
    (12 lines inserted after line 196, before the @see Create() line)

Notes for Reviewers

  • Pure documentation change — zero risk to ABI, API, or build.
  • Follows the existing Doxygen @code/@endcode style already used
    elsewhere in the file.
  • Aims to address the same beginner pain point raised in PR #26589,
    but non-invasively, in the class reference itself.

You can view, comment on, or merge this pull request online at:

  https://github.com/wxWidgets/wxWidgets/pull/26643

Commit Summary

  • 627e8d9 docs: add annotated wxFrame constructor example to reference

File Changes

(1 file)

Patch Links:


Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.Message ID: <wxWidgets/wxWidgets/pull/26643@github.com>

Reply all
Reply to author
Forward
0 new messages