Skip to content

Commit 2bfc3fd

Browse files
SunBK201SunBK201
committed
docs: simplify class documentation by removing unnecessary attributes and methods
1 parent fd8b9f7 commit 2bfc3fd

File tree

8 files changed

+23
-197
lines changed

8 files changed

+23
-197
lines changed

‎docs/classes/scubatrace.File.rst‎

Lines changed: 3 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,6 @@
1-
File
1+
File
22
========
33

44
.. autoclass:: scubatrace.File
5-
6-
Attributes
7-
----------
8-
.. autoattribute:: name
9-
.. autoattribute:: signature
10-
.. autoattribute:: abspath
11-
.. autoattribute:: relpath
12-
.. autoattribute:: uri
13-
.. autoattribute:: text
14-
.. autoattribute:: lines
15-
.. autoattribute:: parser
16-
.. autoattribute:: node
17-
.. autoattribute:: imports
18-
.. autoattribute:: classes
19-
.. autoattribute:: functions
20-
.. autoattribute:: statements
21-
.. autoattribute:: identifiers
22-
.. autoattribute:: variables
23-
.. autoattribute:: is_external
24-
25-
Methods
26-
-------
27-
28-
.. automethod:: File
29-
.. automethod:: function_by_line
30-
.. automethod:: statements_by_line
31-
32-
Special Methods
33-
---------------
34-
35-
.. automethod:: __str__
36-
.. automethod:: __hash__
37-
5+
:members:
6+
:show-inheritance:

‎docs/classes/scubatrace.Function.rst‎

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,6 @@
1-
Function
1+
Function
22
========
33

44
.. autoclass:: scubatrace.Function
5-
6-
Attributes
7-
----------
8-
.. autoattribute:: name
9-
.. autoattribute:: signature
10-
.. autoattribute:: lines
11-
.. autoattribute:: name_node
12-
.. autoattribute:: body_node
13-
.. autoattribute:: body_start_line
14-
.. autoattribute:: body_end_line
15-
.. autoattribute:: parameter_lines
16-
.. autoattribute:: callers
17-
.. autoattribute:: callees
18-
.. autoattribute:: calls
19-
.. autoattribute:: is_external
20-
.. autoattribute:: accessible_functions
21-
22-
Methods
23-
-------
24-
25-
.. automethod:: Function
26-
.. automethod:: statements_by_type
27-
.. automethod:: slice_by_statements
28-
.. automethod:: slice_by_lines
29-
.. automethod:: export_cfg_dot
5+
:members:
6+
:show-inheritance:

‎docs/classes/scubatrace.Identifier.rst‎

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,6 @@ Identifier
22
==========
33

44
.. autoclass:: scubatrace.Identifier
5-
6-
Attributes
7-
----------
8-
.. autoattribute:: name
9-
.. autoattribute:: signature
10-
.. autoattribute:: text
11-
.. autoattribute:: start_line
12-
.. autoattribute:: end_line
13-
.. autoattribute:: start_column
14-
.. autoattribute:: end_column
15-
.. autoattribute:: length
16-
.. autoattribute:: file
17-
.. autoattribute:: function
18-
.. autoattribute:: references
19-
.. autoattribute:: definitions
20-
.. autoattribute:: is_taint_from_entry
21-
.. autoattribute:: is_left_value
22-
.. autoattribute:: is_right_value
23-
.. autoattribute:: pre_data_dependents
24-
.. autoattribute:: post_data_dependents
25-
26-
Special Methods
27-
---------------
28-
29-
.. automethod:: __str__
30-
.. automethod:: __eq__
31-
.. automethod:: __hash__
5+
:members:
6+
:show-inheritance:
327

‎docs/classes/scubatrace.Language.rst‎

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,7 @@
1-
Language
1+
Language
22
========
33

44
.. autoclass:: scubatrace.Language
5-
6-
Attributes
7-
----------
8-
.. autoattribute:: extensions
9-
.. autoattribute:: query_error
10-
.. autoattribute:: query_function
11-
.. autoattribute:: query_identifier
12-
.. autoattribute:: query_return
13-
.. autoattribute:: query_call
14-
.. autoattribute:: jump_statements
15-
.. autoattribute:: loop_statements
16-
.. autoattribute:: block_statements
17-
.. autoattribute:: simple_statements
18-
.. autoattribute:: control_statements
19-
20-
Methods
21-
-------
22-
.. automethod:: is_simple_node
23-
.. automethod:: is_block_node
24-
.. automethod:: query_left_value
25-
5+
:members:
6+
:show-inheritance:
267

‎docs/classes/scubatrace.Parser.rst‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
1-
Parser
1+
Parser
22
========
33

44
.. autoclass:: scubatrace.Parser
5-
6-
Methods
7-
-------
8-
9-
.. automethod:: parse
10-
.. automethod:: traverse_tree
11-
.. automethod:: query
12-
.. automethod:: query_oneshot
13-
.. automethod:: query_all
14-
.. automethod:: query_by_capture_name
5+
:members:
6+
:show-inheritance:
157

‎docs/classes/scubatrace.Project.rst‎

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,7 @@
1-
Project
1+
Project
22
========
33

44
.. autoclass:: scubatrace.Project
5-
6-
Attributes
7-
----------
8-
.. autoattribute:: files
9-
.. autoattribute:: functions
10-
.. autoattribute:: callgraph
11-
.. autoattribute:: abspath
12-
.. autoattribute:: files_abspath
13-
.. autoattribute:: files_uri
14-
.. autoattribute:: sub_dirs
15-
.. autoattribute:: parser
16-
.. autoattribute:: entry_point
17-
18-
Methods
19-
-------
20-
.. automethod:: Project
21-
.. automethod:: export_callgraph
5+
:members:
6+
:show-inheritance:
7+

‎docs/classes/scubatrace.Statement.rst‎

Lines changed: 4 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,7 @@
1-
Statement
1+
Statement
22
=========
33

44
.. autoclass:: scubatrace.Statement
5-
6-
Attributes
7-
----------
8-
.. autoattribute:: is_jump_statement
9-
.. autoattribute:: identifiers
10-
.. autoattribute:: variables
11-
.. autoattribute:: right_values
12-
.. autoattribute:: left_values
13-
.. autoattribute:: signature
14-
.. autoattribute:: text
15-
.. autoattribute:: start_line
16-
.. autoattribute:: end_line
17-
.. autoattribute:: start_column
18-
.. autoattribute:: end_column
19-
.. autoattribute:: length
20-
.. autoattribute:: file
21-
.. autoattribute:: function
22-
.. autoattribute:: post_controls
23-
.. autoattribute:: pre_controls
24-
.. autoattribute:: post_control_dependents
25-
.. autoattribute:: pre_control_dependents
26-
.. autoattribute:: pre_data_dependents
27-
.. autoattribute:: post_data_dependents
28-
.. autoattribute:: references
29-
.. autoattribute:: definitions
30-
.. autoattribute:: is_taint_from_entry
31-
32-
Methods
33-
-------
34-
.. automethod:: walk_backward
35-
.. automethod:: walk_forward
36-
37-
Special Methods
38-
---------------
39-
.. automethod:: __str__
40-
.. automethod:: __eq__
41-
.. automethod:: __hash__
42-
43-
.. autoclass:: scubatrace.SimpleStatement
44-
45-
.. autoclass:: scubatrace.BlockStatement
46-
47-
Attributes
48-
----------
49-
.. autoattribute:: statements
50-
.. autoattribute:: block_identifiers
51-
.. autoattribute:: block_variables
52-
53-
Methods
54-
-------
55-
.. automethod:: statements_by_line
56-
.. automethod:: statements_by_type
57-
.. automethod:: statement_by_field_name
58-
59-
Special Methods
60-
---------------
61-
.. automethod:: __getitem__
5+
:members:
6+
:show-inheritance:
7+

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
language = "en"
3434

3535
autoclass_content = "class"
36-
autodoc_member_order = "alphabetical"
36+
autodoc_member_order = "groupwise"
3737
autosummary_generate = False
3838

3939
# -- Options for HTML output -------------------------------------------------

0 commit comments

Comments
 (0)