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.

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

fix: simplify the API documentation #132

Merged
merged 1 commit into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/core/classsymbol.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ namespace Core {
/*!
* \qmltype ClassSymbol
* \brief Represents a class in the current file
* \inqmlmodule Knut
* \ingroup CodeDocument
* \todo
*/
Expand Down
1 change: 0 additions & 1 deletion src/core/codedocument.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ namespace Core {
/*!
* \qmltype CodeDocument
* \brief Base document object for any code that Knut can parse.
* \inqmlmodule Knut
* \ingroup CodeDocument/@first
* \inherits TextDocument
*
Expand Down
1 change: 0 additions & 1 deletion src/core/cppdocument.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,6 @@ namespace Core {
/*!
* \qmltype CppDocument
* \brief Document object for a C++ file (source or header)
* \inqmlmodule Knut
* \ingroup CppDocument/@first
* \inherits CodeDocument
*/
Expand Down
2 changes: 0 additions & 2 deletions src/core/dataexchange.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ namespace Core {
/*!
* \qmltype DataExchangeEntry
* \brief Refers to a single entry within the `DoDataExchange`
* \inqmlmodule Knut
* \ingroup CppDocument
* \sa DataExchange
*
Expand Down Expand Up @@ -102,7 +101,6 @@ static QList<DataValidationEntry> queryDDVCalls(const QueryMatch &ddxFunction)
/*!
* \qmltype DataExchange
* \brief DataExchange entries in a MFC C++ document.
* \inqmlmodule Knut
* \ingroup CppDocument
*
* The `DataExchange` object represents the data contained in the MFC `DoDataExchange` method.
Expand Down
1 change: 0 additions & 1 deletion src/core/dir.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ namespace Core {
/*!
* \qmltype Dir
* \brief Singleton with methods to handle directories.
* \inqmlmodule Knut
* \ingroup Utilities
*
* The `Dir` singleton implements most of the static methods from `QDir`, check [QDir](https://doc.qt.io/qt-6/qdir.html)
Expand Down
1 change: 0 additions & 1 deletion src/core/document.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ namespace Core {
/*!
* \qmltype Document
* \brief Base class for all documents
* \inqmlmodule Knut
*
* The `Document` class is the base class for all documents.
* A document is a file loaded by Knut and that can be used in script (either to get data or to edit).
Expand Down
1 change: 0 additions & 1 deletion src/core/file.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace Core {
/*!
* \qmltype File
* \brief Singleton with methods to handle files.
* \inqmlmodule Knut
* \ingroup Utilities
*
* The `File` singleton implements most of the static methods from `QFile`, check
Expand Down
1 change: 0 additions & 1 deletion src/core/fileinfo.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ namespace Core {
/*!
* \qmltype FileInfo
* \brief Singleton with methods to handle file information.
* \inqmlmodule Knut
* \ingroup Utilities
*
* The `FileInfo` singleton implements most of the static methods from `QFileInfo`, check
Expand Down
2 changes: 0 additions & 2 deletions src/core/functionsymbol.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace Core {
/*!
* \qmltype FunctionArgument
* \brief Represents an argument to be passed to the function
* \inqmlmodule Knut
* \ingroup CodeDocument
* \todo
* \sa FunctionSymbol
Expand All @@ -37,7 +36,6 @@ namespace Core {
/*!
* \qmltype FunctionSymbol
* \brief Represents a function or a method in the current file
* \inqmlmodule Knut
* \ingroup CodeDocument
* \todo
*/
Expand Down
1 change: 0 additions & 1 deletion src/core/mark.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ namespace Core {
/*!
* \qmltype Mark
* \brief Keeps track of a position in a text document.
* \inqmlmodule Knut
* \ingroup TextDocument
* \sa TextDocument
*
Expand Down
1 change: 0 additions & 1 deletion src/core/message.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ namespace Core {
/*!
* \qmltype Message
* \brief Singleton with methods to display different messages to the user.
* \inqmlmodule Knut
* \ingroup Utilities
*
* The `message` property in QML can be used to display different messages to the user, via logs.
Expand Down
2 changes: 0 additions & 2 deletions src/core/messagemap.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ namespace Core {
/*!
* \qmltype MessageMapEntry
* \brief Refers to a single entry within the `MessageMap`
* \inqmlmodule Knut
* \ingroup CppDocument
* \sa MessageMap
*
Expand Down Expand Up @@ -71,7 +70,6 @@ MessageMapEntry fromMessage(const QueryMatch &match, const RangeMark &range)
/*!
* \qmltype MessageMap
* \brief Message map in a MFC C++ document
* \inqmlmodule Knut
* \ingroup CppDocument
*
* The `MessageMap` object represents the data contained in the MFC MessageMap.
Expand Down
1 change: 0 additions & 1 deletion src/core/project.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ namespace Core {
/*!
* \qmltype Project
* \brief Singleton for handling the current project.
* \inqmlmodule Knut
* The `Project` object is not meant to open multiple projects, but only open one.
*/

Expand Down
1 change: 0 additions & 1 deletion src/core/qdirvaluetype.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ namespace Core {
/*!
* \qmltype QDirValueType
* \brief Wrapper around the `QDir` class.
* \inqmlmodule Knut
* \ingroup Utilities/@last
* \sa Dir
*
Expand Down
1 change: 0 additions & 1 deletion src/core/qfileinfovaluetype.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ namespace Core {
/*!
* \qmltype QFileInfoValueType
* \brief Wrapper around the `QFileInfo` class.
* \inqmlmodule Knut
* \ingroup Utilities/@last
* \sa FileInfo
*
Expand Down
2 changes: 0 additions & 2 deletions src/core/qttsdocument.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ namespace Core {
/*!
* \qmltype QtTsDocument
* \brief Provides access to the content of a Ts file (Qt linguist).
* \inqmlmodule Knut
* \ingroup QtTsDocument/@first
*/

Expand Down Expand Up @@ -288,7 +287,6 @@ QList<QtTsMessage *> QtTsDocument::messages() const
/*!
* \qmltype QtTsMessage
* \brief Provides access to message.
* \inqmlmodule Knut
* \ingroup QtTsDocument
* \sa QtTsDocument
*/
Expand Down
2 changes: 0 additions & 2 deletions src/core/qtuidocument.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ namespace Core {
/*!
* \qmltype QtUiDocument
* \brief Provides access to the content of a Ui file (Qt designer file).
* \inqmlmodule Knut
* \ingroup QtUiDocument/@first
*/

Expand Down Expand Up @@ -171,7 +170,6 @@ Utils::QtUiWriter *QtUiDocument::uiWriter()
/*!
* \qmltype QtUiWidget
* \brief Provides access to widget attributes in the ui files.
* \inqmlmodule Knut
* \ingroup QtUiDocument
* \sa QtUiDocument
*/
Expand Down
2 changes: 0 additions & 2 deletions src/core/querymatch.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ namespace Core {
/*!
* \qmltype QueryCapture
* \brief Defines a capture made by a query.
* \inqmlmodule Knut
* \ingroup CodeDocument
* \sa QueryMatch
*/
Expand All @@ -45,7 +44,6 @@ QString QueryCapture::toString() const
/*!
* \qmltype QueryMatch
* \brief Contains all captures for a query match.
* \inqmlmodule Knut
* \ingroup CodeDocument
* \sa CodeDocument::query
*
Expand Down
1 change: 0 additions & 1 deletion src/core/rangemark.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ namespace Core {
/*!
* \qmltype RangeMark
* \brief Keeps track of a range within a text document.
* \inqmlmodule Knut
* \ingroup TextDocument
* \sa TextDocument
*
Expand Down
1 change: 0 additions & 1 deletion src/core/rcdocument.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ namespace Core {
/*!
* \qmltype RcDocument
* \brief Provides access to the content of a RC file (MFC resource file).
* \inqmlmodule Knut
* \ingroup RcDocument/@first
*/

Expand Down
1 change: 0 additions & 1 deletion src/core/scriptdialogitem.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ namespace Core {
/*!
* \qmltype ScriptDialog
* \brief QML Item for writing visual scripts.
* \inqmlmodule Knut
* \ingroup Items
*
* The `ScriptDialog` allows creating a script dialog based on a ui file. It requires creating a ui file with the same
Expand Down
1 change: 0 additions & 1 deletion src/core/scriptitem.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ namespace Core {
/*!
* \qmltype Script
* \brief Script object for writing non visual scripts.
* \inqmlmodule Knut
* \ingroup Items
*
* The `Script` is the base class for all creatable items in QML. It is needed as a `QtObject`
Expand Down
1 change: 0 additions & 1 deletion src/core/settings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ static constexpr char SettingsName[] = "knut.json";
/*!
* \qmltype Settings
* \brief Singleton for accessing and editing persistent settings.
* \inqmlmodule Knut
* \ingroup Utilities
*
* The settings are stored in a json file, and could be:
Expand Down
1 change: 0 additions & 1 deletion src/core/symbol.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ namespace Core {
/*!
* \qmltype Symbol
* \brief Represent a symbol in the current file
* \inqmlmodule Knut
* \ingroup CodeDocument
*/

Expand Down
1 change: 0 additions & 1 deletion src/core/textdocument.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ matchInBlock(const QTextBlock &block, const QRegularExpression &expr, int offset
/*!
* \qmltype TextDocument
* \brief Document object for text files.
* \inqmlmodule Knut
* \ingroup TextDocument/@first
* \inherits Document
*/
Expand Down
1 change: 0 additions & 1 deletion src/core/typedsymbol.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ namespace Core {
/*!
* \qmltype TypedSymbol
* \brief Represents a symbol with a type
* \inqmlmodule Knut
* \ingroup CodeDocument
*
* This symbol has a type associated with it, like a variable or a member of a class.
Expand Down
1 change: 0 additions & 1 deletion src/core/userdialog.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ namespace Core {
/*!
* \qmltype UserDialog
* \brief Singleton with methods to display common dialog to the user.
* \inqmlmodule Knut
* \ingroup Utilities
*
* The `UserDialog` singleton provides methods to display common dialog that could be used in
Expand Down
1 change: 0 additions & 1 deletion src/core/utils.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ namespace Core {
/*!
* \qmltype Utils
* \brief Singleton with utility methods.
* \inqmlmodule Knut
* \ingroup Utilities
*
* The `Utils` singleton implements some utility methods useful for scripts.
Expand Down
9 changes: 0 additions & 9 deletions src/rccore/data.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ namespace RcCore {
/*!
* \qmltype Asset
* \brief Description of a RC file asset.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*/
Expand All @@ -37,7 +36,6 @@ namespace RcCore {
/*!
* \qmltype ToolBarItem
* \brief Description of a RC file toolbar item.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*/
Expand All @@ -53,7 +51,6 @@ namespace RcCore {
/*!
* \qmltype ToolBar
* \brief Description of a RC file toolbar.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*/
Expand All @@ -77,7 +74,6 @@ namespace RcCore {
/*!
* \qmltype Widget
* \brief Description of a RC file widget.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*/
Expand Down Expand Up @@ -109,7 +105,6 @@ namespace RcCore {
/*!
* \qmltype MenuItem
* \brief Description of a RC file menu item.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*/
Expand Down Expand Up @@ -141,7 +136,6 @@ namespace RcCore {
/*!
* \qmltype Menu
* \brief Description of a RC file menu.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*/
Expand All @@ -161,7 +155,6 @@ namespace RcCore {
/*!
* \qmltype Shortcut
* \brief Description of a RC file shortcut.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*/
Expand All @@ -177,7 +170,6 @@ namespace RcCore {
/*!
* \qmltype Action
* \brief Description of a RC file action.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*/
Expand Down Expand Up @@ -217,7 +209,6 @@ namespace RcCore {
/*!
* \qmltype String
* \brief Description of a RC file string.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*/
Expand Down
6 changes: 0 additions & 6 deletions src/rccore/ribbon.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ namespace RcCore {
/*!
* \qmltype RibbonElement
* \brief An item in the ribbon (button, separator...).
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa Ribbon
*/
Expand Down Expand Up @@ -57,7 +56,6 @@ namespace RcCore {
/*!
* \qmltype RibbonPanel
* \brief An panel (group of elements) in the ribbon.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa Ribbon
*/
Expand All @@ -77,7 +75,6 @@ namespace RcCore {
/*!
* \qmltype RibbonCategory
* \brief A tab (made of panels) in the ribbon.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa Ribbon
*/
Expand Down Expand Up @@ -105,7 +102,6 @@ namespace RcCore {
/*!
* \qmltype RibbonContext
* \brief A context (tabs with a title) in the ribbon.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa Ribbon
*/
Expand All @@ -125,7 +121,6 @@ namespace RcCore {
/*!
* \qmltype RibbonMenu
* \brief A menu showing when clicking on the left/top icon in the ribbon.
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa Ribbon
*/
Expand Down Expand Up @@ -153,7 +148,6 @@ namespace RcCore {
/*!
* \qmltype Ribbon
* \brief The ribbon description (not everything is read yet).
* \inqmlmodule Knut
* \ingroup RcDocument
* \sa RcFile
*
Expand Down
Loading
Loading