Skip to content

Documenting the code via doxygen#3

Merged
wmiler merged 3 commits into
JS8Call-improved:masterfrom
wmiler:master
Oct 24, 2025
Merged

Documenting the code via doxygen#3
wmiler merged 3 commits into
JS8Call-improved:masterfrom
wmiler:master

Conversation

@wmiler

@wmiler wmiler commented Oct 23, 2025

Copy link
Copy Markdown
Collaborator

This is just the config file for running doxygen against the tree.
Stores the generated html in ./docs/html/

Config file for doxygen doc builder
@wmiler wmiler added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 23, 2025
@wmiler wmiler self-assigned this Oct 23, 2025
@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

Wyatt, I don't see any reviews really necessary for this one. If you are happy with it just go ahead and merge it to master.

@wmiler wmiler merged commit 339bd2e into JS8Call-improved:master Oct 24, 2025
@aknrdureegaesr

aknrdureegaesr commented Oct 24, 2025

Copy link
Copy Markdown
Collaborator

I mildly object to this being merged: I expect the folder where the doxygen stuff is generated to be added to .gitignore.

Not a second objection, but I would very much like to see a short how-to added to the project. I suggest starting a new file CONTRIBUTING or, possibly better yet, CONTRIBUTING.md that has a couple of lines on this or three. Lest every developer who's never used doxygen needs to go to the web side, one developer at a time.

@aknrdureegaesr

Copy link
Copy Markdown
Collaborator

(Yes, I did notice the breach of process and understand my objection comes to late to be addressed before the merge. I don't know what to think about it. If you people do not discuss my proposal and also ignore it, why the heck did I bother writing it up?)

@wmiler

wmiler commented Oct 25, 2025

Copy link
Copy Markdown
Collaborator Author

Yes, I did fail to add it to the .gitignore, I actually had a d'oh moment earlier today to that effect. I blame @Chris-AC9KH for the fast merge since he effectively signed off on it. 🙄 I'll do better next time, I promise!

@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

(Yes, I did notice the breach of process and understand my objection comes to late to be addressed before the merge. I don't know what to think about it. If you people do not discuss my proposal and also ignore it, why the heck did I bother writing it up?)

This was a simple configuration file that doesn't change the functionality of the code, and that I didn't see any reason to leave it as a open PR. Modifications to it can be easily made with subsequent PR.

@aknrdureegaesr

Copy link
Copy Markdown
Collaborator

So we should augment the rule? "If a reviewer is certain a change is low risk, the merge may be done by that reviewer." or something?

@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

As far as that goes, there's other things yet that should probably be added to .gitignore. Xcode can put a new artifact I discovered into the source tree (depending on how Xcode is set up) for app entitlements.

@wmiler wmiler mentioned this pull request Oct 25, 2025
@Chris-AC9KH

Chris-AC9KH commented Oct 25, 2025

Copy link
Copy Markdown
Collaborator

I suggest starting a new file CONTRIBUTING or, possibly better yet, CONTRIBUTING.md that has a couple of lines on this or three. Lest every developer who's never used doxygen needs to go to the web side, one developer at a time.

@aknrdureegaesr there is a contributor's guide in the docs (at least in JS8Call-improved):

https://github.com/Chris-AC9KH/JS8Call-improved/blob/master/docs/CONTRIBUTOR_GUIDE.md

If it needs changing for here (it likely does), then feel free to make any changes to it. It was included in the documentation update I did on JS8Call official, but never merged (yet).

I see zero reason to leave simple PR's that don't change the functionality of the codebase, but they add necessary development features. These can just be merged without going thru any formal review process. They are easy to reverse, or change, with subsequent PR's without affecting the build-ability or functionality of the code. It helps to keep the PR list cleaned up, and if something was missed just fix it with another PR and move on. I've got one coming up with a new tools directory with linux build scripts that is the same thing. I wouldn't expect wasting everybody's time going thru a formal review process for such a thing. If two developers agree on it, merge it.

bg7ipb added a commit to bg7ipb/JS8Call-improved that referenced this pull request Jun 21, 2026
JS8Call-improved#3 waterfall right-panel Control/Display/Timing tabs CN visible (User verified).

- 69 EN sources → CN: 控制/显示/时序 三 tab + 子控件 (label/tooltip/spinbox 后缀)
- QSY 保英文 (§4 缩写锁); NORMAL/SLOW 保英文 (tooltip 内 JS8 mode names)
- TX cycle → 发射 (JS8Call-improved#63-66); Timing → 时序 (JS8Call-improved#52)
- Offset → 频偏 (JS8Call-improved#3, 与 JS8Call-improved#5 Offset:→频偏: 对偶, 覆盖 lupdate same-text body-fill stub 偏移)
- lupdate fresh: Found 851 source text(s) (0 new), FALSIFIER① 排除

Known limitations:
- EN switch 需 restart (PARK-092 sub-window changeEvent override 共缺, 接受)
- Directed-to 切换"闪现-回 EN" → PARK-095 (动态 menu lifecycle, 另开 sub-phase)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants