Skip to content

Commit 7c6341a

Browse files
committed
docs: improve API reference and fix local builds
API Reference improvements: - Better organization by category (Core, Node, Connection, etc.) - Added missing classes: StyleCollection, CreateCommand, CopyCommand, PasteCommand - Added new structs: NodeValidationState, ProcessingIconStyle - Added new enums: NodeProcessingStatus, ProcessingIconPos - Removed non-existent DuplicateCommand - Fixed anonymous enum warnings with :no-link: directive Build fix: - Added breathe config for local Doxygen XML builds
1 parent 0842ceb commit 7c6341a

2 files changed

Lines changed: 92 additions & 28 deletions

File tree

docs/api/classes.rst

Lines changed: 87 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,57 @@
11
QtNodes Class Reference
22
=======================
33

4-
Basic Classes
5-
-------------
4+
This page provides auto-generated API documentation from the source code.
5+
6+
Core Classes
7+
------------
8+
9+
Graph Model
10+
^^^^^^^^^^^
611

712
.. doxygenclass:: QtNodes::AbstractGraphModel
813
:members:
914

10-
.. doxygenstruct:: QtNodes::NodeDataType
15+
.. doxygenclass:: QtNodes::DataFlowGraphModel
1116
:members:
1217

13-
.. doxygenclass:: QtNodes::NodeData
14-
:members:
18+
Scene and View
19+
^^^^^^^^^^^^^^
1520

16-
.. doxygenstruct:: QtNodes::ConnectionId
21+
.. doxygenclass:: QtNodes::BasicGraphicsScene
1722
:members:
1823

19-
.. doxygenclass:: QtNodes::BasicGraphicsScene
24+
.. doxygenclass:: QtNodes::DataFlowGraphicsScene
2025
:members:
2126

2227
.. doxygenclass:: QtNodes::GraphicsView
2328
:members:
2429

25-
.. doxygenclass:: QtNodes::GraphicsViewStyle
26-
:members:
30+
Node Classes
31+
------------
32+
33+
Graphics
34+
^^^^^^^^
2735

2836
.. doxygenclass:: QtNodes::NodeGraphicsObject
2937
:members:
38+
:no-link:
39+
40+
.. doxygenclass:: QtNodes::NodeState
41+
:members:
42+
43+
Painting
44+
^^^^^^^^
3045

3146
.. doxygenclass:: QtNodes::AbstractNodePainter
3247
:members:
3348

3449
.. doxygenclass:: QtNodes::DefaultNodePainter
3550
:members:
3651

52+
Geometry
53+
^^^^^^^^
54+
3755
.. doxygenclass:: QtNodes::AbstractNodeGeometry
3856
:members:
3957

@@ -43,70 +61,111 @@ Basic Classes
4361
.. doxygenclass:: QtNodes::DefaultVerticalNodeGeometry
4462
:members:
4563

46-
.. doxygenclass:: QtNodes::NodeState
47-
:members:
64+
Connection Classes
65+
------------------
4866

49-
.. doxygenclass:: QtNodes::NodeStyle
67+
.. doxygenclass:: QtNodes::ConnectionGraphicsObject
5068
:members:
69+
:no-link:
5170

52-
.. doxygenclass:: QtNodes::ConnectionGraphicsObject
71+
.. doxygenclass:: QtNodes::AbstractConnectionPainter
5372
:members:
5473

5574
.. doxygenclass:: QtNodes::DefaultConnectionPainter
5675
:members:
5776

77+
.. doxygenclass:: QtNodes::NodeConnectionInteraction
78+
:members:
79+
80+
Data Flow Classes
81+
-----------------
82+
83+
.. doxygenclass:: QtNodes::NodeDelegateModel
84+
:members:
85+
86+
.. doxygenclass:: QtNodes::NodeDelegateModelRegistry
87+
:members:
88+
89+
.. doxygenclass:: QtNodes::NodeData
90+
:members:
91+
92+
Styling
93+
-------
94+
95+
.. doxygenclass:: QtNodes::NodeStyle
96+
:members:
97+
5898
.. doxygenclass:: QtNodes::ConnectionStyle
5999
:members:
60100

61-
.. doxygenclass:: QtNodes::NodeConnectionInteraction
101+
.. doxygenclass:: QtNodes::GraphicsViewStyle
102+
:members:
103+
104+
.. doxygenclass:: QtNodes::StyleCollection
62105
:members:
63106

64-
Undo Redo
65-
---------
107+
Undo Commands
108+
-------------
109+
110+
.. doxygenclass:: QtNodes::CreateCommand
111+
:members:
66112

67113
.. doxygenclass:: QtNodes::DeleteCommand
68114
:members:
69115

70-
.. doxygenclass:: QtNodes::DuplicateCommand
116+
.. doxygenclass:: QtNodes::ConnectCommand
71117
:members:
72118

73119
.. doxygenclass:: QtNodes::DisconnectCommand
74120
:members:
75121

76-
.. doxygenclass:: QtNodes::ConnectCommand
122+
.. doxygenclass:: QtNodes::MoveNodeCommand
77123
:members:
78124

79-
.. doxygenclass:: QtNodes::MoveNodeCommand
125+
.. doxygenclass:: QtNodes::CopyCommand
80126
:members:
81127

82-
Dataflow Classes
83-
----------------
128+
.. doxygenclass:: QtNodes::PasteCommand
129+
:members:
84130

85-
.. doxygenclass:: QtNodes::DataFlowGraphicsScene
131+
Data Types
132+
----------
133+
134+
Structs
135+
^^^^^^^
136+
137+
.. doxygenstruct:: QtNodes::NodeDataType
86138
:members:
87139

88-
.. doxygenclass:: QtNodes::DataFlowGraphModel
140+
.. doxygenstruct:: QtNodes::ConnectionId
89141
:members:
90142

91-
.. doxygenclass:: QtNodes::NodeDelegateModel
143+
.. doxygenstruct:: QtNodes::NodeValidationState
92144
:members:
93145

94-
.. doxygenclass:: QtNodes::NodeDelegateModelRegistry
146+
.. doxygenstruct:: QtNodes::ProcessingIconStyle
95147
:members:
96148

97-
Definitions
98-
-----------
149+
Type Definitions
150+
^^^^^^^^^^^^^^^^
99151

100152
.. doxygentypedef:: QtNodes::NodeId
101153

102154
.. doxygentypedef:: QtNodes::PortIndex
103155

156+
Enumerations
157+
^^^^^^^^^^^^
158+
104159
.. doxygenenum:: QtNodes::NodeRole
105160

106161
.. doxygenenum:: QtNodes::NodeFlag
107162

108163
.. doxygenenum:: QtNodes::PortRole
109164

165+
.. doxygenenum:: QtNodes::PortType
166+
110167
.. doxygenenum:: QtNodes::ConnectionPolicy
111168

112-
.. doxygenenum:: QtNodes::PortType
169+
.. doxygenenum:: QtNodes::NodeProcessingStatus
170+
171+
.. doxygenenum:: QtNodes::ProcessingIconPos

docs/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ def configureDoxyfile(input_dir, output_dir):
2121
configureDoxyfile(input_dir, output_dir)
2222
subprocess.call('doxygen', shell=True)
2323
breathe_projects['QtNodes'] = output_dir + '/xml/'
24+
else:
25+
# Local build: use CMake-generated Doxygen XML
26+
build_xml_path = '../build/docs/doxygen/xml/'
27+
if os.path.exists(build_xml_path):
28+
breathe_projects['QtNodes'] = build_xml_path
2429

2530

2631
# -- Project information -----------------------------------------------------

0 commit comments

Comments
 (0)