Skip to content

Commit ca46067

Browse files
committed
Update docs
1 parent 54fee85 commit ca46067

File tree

3 files changed

+30
-6
lines changed

3 files changed

+30
-6
lines changed

docs/use/using-cli.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,10 @@ Run the command to know the usage of CLI
6464
--detailedStatsFile, -detailedStatsMetrics -> Detailed Statistics Metrics CSV files (separated by commas) { String }
6565
--composableMetricsFile, -composableMetrics -> Composable Metrics TXT files (separated by commas) { String }
6666
--classMetricsFile, -classMetrics -> Class Metrics TXT files (separated by commas) { String }
67-
--outputDirectory, -o -> Output directory name { String }
67+
--outputDirectory, -o [F:\Work\MyProHub\compose-report-to-html\cli\build\libs] -> Output directory name { String }
68+
--includeStableComposables [true] -> Whether to include stable Composable functions in the report
69+
--includeStableClasses [true] -> Whether to include stable classes in the report
70+
--includeClasses [true] -> Whether to include all the classes in the report
6871
--help, -h -> Usage info
6972
```
7073

docs/use/using-gradle-plugin.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,17 @@ If you have to configure plugin parameters manually (which is completely optiona
122122
// Sets the name for a report
123123
name = "Report Name" // Default: Module name
124124

125-
// Output path where report will be generated
126-
outputPath = project.buildDir.absolutePath + "/custom_path" // Default: module/buildDir/compose_report
125+
// Output directory where report will be generated
126+
outputDirectory = layout.buildDirectory.dir("custom_dir").get().asFile // Default: module/buildDir/compose_report
127+
128+
// Whether to include stable composable functions in the final report or not.
129+
includeStableComposables = true/false // Default: true
130+
131+
// Whether to include stable classes in the final report or not.
132+
includeStableClasses = true/false // Default: true
133+
134+
// Whether to include the ALL classes in the final report or not.
135+
includeClasses = true/false // Default: true
127136
}
128137
```
129138

@@ -140,7 +149,16 @@ If you have to configure plugin parameters manually (which is completely optiona
140149
// Sets the name for a report
141150
name.set("Report Name") // Default: Module name
142151

143-
// Output path where report will be generated
144-
outputPath.set(project.buildDir.resolve("custom_path").absolutePath) // Default: module/buildDir/compose_report
152+
// Output directory where report will be generated
153+
outputDirectory.set(layout.buildDirectory.dir("custom_dir").get().asFile) // Default: module/buildDir/compose_report
154+
155+
// Whether to include stable composable functions in the final report or not.
156+
includeStableComposables.set(true/false) // Default: true
157+
158+
// Whether to include stable classes in the final report or not.
159+
includeStableClasses.set(true/false) // Default: true
160+
161+
// Whether to include the ALL classes in the final report or not.
162+
includeClasses.set(true/false) // Default: true
145163
}
146164
```

docs/use/using-utility-as-library.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ Refer to the latest release on [GitHub Releases](https://github.com/PatilShreyas
2525

2626
```kotlin
2727
// Create a report specification with application name
28-
val reportSpec = ReportSpec("Your Application Name")
28+
val reportSpec = ReportSpec(
29+
name = "Your Application Name",
30+
options = ReportOptions() // Customize it as per need
31+
)
2932

3033
// Get provider for raw reports (generated by compose compiler)
3134
val rawReportProvider = ComposeCompilerRawReportProvider.FromDirectory("path/to/raw-reports")

0 commit comments

Comments
 (0)