Skip to content

Commit ecfffca

Browse files
committed
docs: update README with class diagram for data structures
1 parent 5256de9 commit ecfffca

1 file changed

Lines changed: 47 additions & 27 deletions

File tree

README.md

Lines changed: 47 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -276,33 +276,53 @@ Syntax parsing identification rules:
276276

277277
### Data structures
278278

279-
```
280-
// for multiple project analysis
281-
code_project
282-
code_module
283-
284-
// for package dependency analysis
285-
code_package_info
286-
code_dependency
287-
288-
// package or file as dependency analysis
289-
code_package
290-
code_container
291-
292-
// class-first or function-first
293-
code_data_struct
294-
code_function
295-
296-
// function or class detail
297-
code_annotation
298-
code_field
299-
code_import
300-
code_member
301-
code_position
302-
code_property
303-
304-
// method call information
305-
code_call
279+
```mermaid
280+
classDiagram
281+
direction TB
282+
283+
%% project/module/package
284+
CodeProject "1" o-- "*" CodeModule : Modules
285+
CodeModule "1" o-- "*" CodePackage : Packages
286+
CodeModule "1" o-- "1" CodePackageInfo : packageInfo
287+
CodePackageInfo "1" o-- "*" CodeDependency : Dependencies
288+
289+
%% package/container
290+
CodePackage "1" o-- "*" CodeContainer : codeContainers
291+
CodePackage "1" o-- "*" CodePackage : Packages
292+
CodeContainer "1" o-- "*" CodeImport : Imports
293+
CodeContainer "1" o-- "*" CodeMember : Members
294+
CodeContainer "1" o-- "*" CodeDataStruct : DataStructures
295+
CodeContainer "1" o-- "*" CodeField : Fields
296+
CodeContainer "1" o-- "*" CodeContainer : Containers
297+
CodeContainer "0..1" o-- "1" TopLevelScope : TopLevel
298+
299+
%% core data structures
300+
CodeDataStruct "1" o-- "*" CodeField : Fields
301+
CodeDataStruct "1" o-- "*" CodeFunction : Functions
302+
CodeDataStruct "1" o-- "*" CodeDataStruct : InnerStructures
303+
CodeDataStruct "1" o-- "*" CodeAnnotation : Annotations
304+
CodeDataStruct "1" o-- "*" CodeCall : FunctionCalls
305+
CodeDataStruct "1" o-- "*" CodeImport : Imports
306+
CodeDataStruct "1" o-- "1" CodePosition : Position
307+
308+
CodeFunction "1" o-- "*" CodeProperty : Parameters
309+
CodeFunction "1" o-- "*" CodeProperty : MultipleReturns
310+
CodeFunction "1" o-- "*" CodeCall : FunctionCalls
311+
CodeFunction "1" o-- "*" CodeAnnotation : Annotations
312+
CodeFunction "1" o-- "*" CodeDataStruct : InnerStructures
313+
CodeFunction "1" o-- "*" CodeFunction : InnerFunctions
314+
CodeFunction "1" o-- "1" CodePosition : Position
315+
316+
CodeField "1" o-- "*" CodeAnnotation : Annotations
317+
CodeField "1" o-- "*" CodeCall : Calls
318+
CodeField "1" o-- "*" CodeField : ArrayValue
319+
320+
CodeCall "1" o-- "*" CodeProperty : Parameters
321+
CodeCall "1" o-- "1" CodePosition : Position
322+
323+
CodeMember "1" o-- "*" CodeDataStruct : StructureNodes
324+
CodeMember "1" o-- "*" CodeFunction : FunctionNodes
325+
CodeMember "1" o-- "1" CodePosition : Position
306326
```
307327

308328
## License

0 commit comments

Comments
 (0)