Skip to content

Commit 68c1eb7

Browse files
committed
docs: update SAST and Dataset class chart
1 parent 6173eb3 commit 68c1eb7

2 files changed

Lines changed: 9 additions & 8 deletions

File tree

docs/dataset/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ classDiagram
3636
+validate(analysis_results) GitRepoDatasetData
3737
}
3838
class File {
39+
+filepath: Path
3940
+filename: str
4041
+content: bytes
4142
+cwes: list~CWE~

docs/sast/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ classDiagram
3232
+output_files: list~tuple~Path, bool~~
3333
+parser: type~AnalysisResult~
3434
+run_analysis(lang, project_dir, output_dir) void
35-
+save_results(project_dir, output_dir, extra) void
35+
+save_results(project_dir, output_dir, analysis_info) void
3636
+analyze_files(dataset, overwrite, testing) void
3737
+analyze_repos(dataset, overwrite, testing) void
3838
+list_results(project, dataset, limit) list~str~
@@ -42,11 +42,11 @@ classDiagram
4242
}
4343
4444
class PrebuiltSAST {
45+
+artifact_name: str
46+
+artifact_type: str
4547
}
4648
4749
class PrebuiltBuildlessSAST {
48-
+artifact_name: str
49-
+artifact_type: str
5050
}
5151
5252
SAST <|-- BuildlessSAST
@@ -61,24 +61,24 @@ classDiagram
6161
+files: list~str~
6262
+defects: list~Defect~
6363
+time: float
64-
+loc: int
64+
+lines_of_codes: int
6565
+load_from_output_dir(output_dir)* Self
6666
+load_from_output_dirs(output_dirs) list~Self~
6767
+stats_by_checkers() dict
68-
+stats_by_categories() dict
68+
+stats_by_levels() dict
6969
+stats_by_files() dict
7070
+stats_by_cwes() dict
7171
}
7272
7373
class Defect {
74-
+sast: str
74+
+sast_name: str
7575
+filepath: Path
7676
+filename: str
7777
+checker: str
78-
+category: str
78+
+level: str
7979
+cwe: CWE
8080
+message: str
81-
+location: tuple~int, int~
81+
+lines: list~int~
8282
}
8383
8484
AnalysisResult --> Defect : contains

0 commit comments

Comments
 (0)