Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Review public API #54

Closed
59 tasks done
narnaud opened this issue Jun 22, 2024 · 1 comment · Fixed by #165
Closed
59 tasks done

Review public API #54

narnaud opened this issue Jun 22, 2024 · 1 comment · Fixed by #165
Assignees
@narnaud
Labels
👷 refactor Something needs to change
Milestone
Release 1.0.0

Comments

@narnaud
Copy link
Member

narnaud commented Jun 22, 2024 •
edited
Loading

For each API, ensure there is:

  • documentation (property or method)
  • ensure the documentation is properly rendered
  • proper LOG

List of API to review:

  • Document
  • Project
  • CodeDocument
    • CodeDocument
    • ClassSymbol
    • FunctionArgument
    • FunctionSymbol
    • QueryCapture
    • QueryMatch
    • Symbol
    • AstNode
  • CppDocument
    • CppDocument
    • DataExchange
    • DataExchangeEntry
    • MessageMap
    • MessageMapEntry
  • QtTsDocument
    • QtTsDocument
    • QtTsMessage
  • QtUiDocument
    • QtUiDocument
    • QtUiWidget
  • RcDocument
    • RcDocument
    • Action
    • Asset
    • Menu
    • MenuItem
    • Ribbon
    • RibbonCategory
    • RibbonContext
    • RibbonElement
    • RibbonMenu
    • RibbonPanel
    • Shortcut
    • String
    • ToolBar
    • ToolBarItem
    • Widget
  • TextDocument
    • TextDocument
    • Mark
    • RangeMark
    • TextLocation
    • TextRange
  • Items
    • Script
    • ScriptDialog
  • Utilities
    • Dir
    • File
    • FileInfo
    • Message
    • Settings
    • UserDialog
    • Utils
    • QDirValueType
    • QFileInfoValueType
@narnaud narnaud added the 👷 refactor Something needs to change label Jun 22, 2024
@narnaud narnaud added this to the Release 1.0.0 milestone Jun 22, 2024
@narnaud narnaud self-assigned this Jun 22, 2024
@narnaud narnaud mentioned this issue Jun 26, 2024
Closed
@narnaud narnaud changed the title Refactor: review class name for the API Review public API Jun 26, 2024
@narnaud narnaud pinned this issue Jun 26, 2024
narnaud added a commit to narnaud/knut that referenced this issue Jul 1, 2024
@narnaud
docs: review the Utils API
595b8e2 
Ensure documentation is up to date, and log is not missing.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 1, 2024
@narnaud
docs: remove old LSP API
20182e0 
No need to document them, as it's only used in the Knut UI.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 1, 2024
@narnaud
docs: Review the item's API
b0039e2 
Improve documentation for `Script` And `ScriptDialog`.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 1, 2024
@narnaud
docs: Review the Document and Project API
b59d388 
Update the documentation a bit.

Related to KDAB#54
@narnaud narnaud mentioned this issue Jul 1, 2024
Merged
narnaud added a commit to narnaud/knut that referenced this issue Jul 3, 2024
@narnaud
docs: remove old LSP API
8138e03 
No need to document them, as it's only used in the Knut UI.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 3, 2024
@narnaud
docs: Review the item's API
f7fc1c0 
Improve documentation for `Script` And `ScriptDialog`.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 3, 2024
@narnaud
docs: Review the Document and Project API
fad1d7b 
Update the documentation a bit.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 5, 2024
@narnaud
docs: review the Utils API
f9503b4 
Ensure documentation is up to date, and log is not missing.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 5, 2024
@narnaud
docs: remove old LSP API
4d54270 
No need to document them, as it's only used in the Knut UI.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 5, 2024
@narnaud
docs: Review the item's API
0578cfa 
Improve documentation for `Script` And `ScriptDialog`.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 5, 2024
@narnaud
docs: Review the Document and Project API
387aa04 
Update the documentation a bit.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 5, 2024
@narnaud
docs: review the Utils API
e40afb5 
Ensure documentation is up to date, and log is not missing.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 5, 2024
@narnaud
docs: remove old LSP API
82a5ef1 
No need to document them, as it's only used in the Knut UI.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 5, 2024
@narnaud
docs: Review the item's API
253070d 
Improve documentation for `Script` And `ScriptDialog`.

Related to KDAB#54
narnaud added a commit to narnaud/knut that referenced this issue Jul 5, 2024
@narnaud
docs: Review the Document and Project API
f196217 
Update the documentation a bit.

Related to KDAB#54
narnaud added a commit that referenced this issue Jul 8, 2024
@narnaud
docs: review the Utils API
c620879 
Ensure documentation is up to date, and log is not missing.

Related to #54
narnaud added a commit that referenced this issue Jul 8, 2024
@narnaud
docs: remove old LSP API
fa004fe 
No need to document them, as it's only used in the Knut UI.

Related to #54
narnaud added a commit that referenced this issue Jul 8, 2024
@narnaud
docs: Review the item's API
4c9d9c8 
Improve documentation for `Script` And `ScriptDialog`.

Related to #54
narnaud added a commit that referenced this issue Jul 8, 2024
@narnaud
docs: Review the Document and Project API
e33a933 
Update the documentation a bit.

Related to #54
@narnaud narnaud mentioned this issue Jul 15, 2024
Merged
narnaud added a commit to narnaud/knut that referenced this issue Jul 15, 2024
@narnaud
docs: Review RcDocument API
dfce05c 
Add missing properties and small doc improvement.

Related-to KDAB#54
@narnaud narnaud mentioned this issue Jul 15, 2024
Merged
narnaud added a commit that referenced this issue Jul 16, 2024
@narnaud
docs: Review RcDocument API
a2f97fb 
Add missing properties and small doc improvement.

Related-to #54
@narnaud narnaud mentioned this issue Sep 13, 2024
Merged
@narnaud
Copy link
Member Author

narnaud commented Sep 30, 2024

All done

@narnaud narnaud closed this as completed Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@narnaud narnaud

Labels
👷 refactor Something needs to change
Projects
None yet
Milestone
Release 1.0.0
Development

Successfully merging a pull request may close this issue.

Finish reviewing the public API narnaud/knut
1 participant
@narnaud