IJHack / QtPass / 24641827230

55%

Build Type

push

github

Committed by web-flow

Commit Message

docs: standardise Doxygen style across headers and main.cpp (#1087)

* docs: standardise Doxygen style across headers and main.cpp

- Remove orphaned doc blocks floating before class definitions
- Convert all /*!  \brief  \param  \return to /**  @brief  @param  @return
- Add @class/@struct/@brief tags to class-level doc comments
- Add missing doc comments to undocumented public methods and slots
- Fix misplaced updateEnv doc block in pass.cpp (was above setEnvVar)
- Update mainpage in main.cpp from \section to @section style

Files: src/passworddialog.h, src/executor.h, src/keygendialog.h,
       src/trayicon.h, src/passwordconfiguration.h, src/userinfo.h,
       src/configdialog.h, src/mainwindow.h, src/pass.cpp, main/main.cpp

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* 📝 Add docstrings to `fix/passworddialog-header-docs`

Docstrings generation was requested by @annejan.

The following files were modified:

* `main/main.cpp`
* `src/configdialog.h`
* `src/executor.h`
* `src/keygendialog.h`
* `src/mainwindow.h`
* `src/pass.cpp`
* `src/trayicon.h`
* `src/userinfo.h`

These files were kept as they were:
* `src/passworddialog.h`

* docs: remove AI-generated orphaned blocks from upstream, fix Qt version

- Remove new orphaned doc blocks introduced by upstream in executor.h,
  trayicon.h, keygendialog.h, userinfo.h, configdialog.h, mainwindow.h
- Update mainpage Qt minimum version from 5.2 to 5.15 (matches CI)
- Add doc comment for joinRemainingArgs in main.cpp

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: add missing class/struct docs and fix coverage gaps

- Add @struct doc to ResolvedGpgconfCommand (pass.h)
- Restore @struct doc to UserInfo (lost during upstream cleanup)
- Add @struct/@class docs to NamedValue, FileContent (filecontent.h)
- Add @class doc to simpleTransaction (simpletransaction.h)
- Remove orphaned method blocks from qtpass.h; add @class doc
  and inline docs for all public methods and slots
- Enab... (continued)

Coverage Stats

2 of 2 new or added lines in 1 file covered. (100.0%)

129 existing lines in 9 files now uncovered.

1596 of 5833 relevant lines covered (27.36%)

18.01 hits per line