Skip to content

Commit 61b315c

Browse files
committed
Reference Converter Documentation in README
1 parent 8177e30 commit 61b315c

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ an OpenAI-API-compatible Large Language Model (LLM) can be used to preprocess do
153153
```commandline
154154
python main.py --project_name test --project_path <path> --converter function_comment_llm --cc_openai_base_url <url> --cc_openai_api_key <key> --cc_llm_model <model>
155155
```
156+
For more details about the comment converter tool's capabilities, see [UsageConverter.md](doc/UsageConverter.md), [AboutExtractor.md](doc/AboutExtractor.md), [AboutCommentStyleConverter.md](doc/AboutCommentStyleConverter.md) and [ArchitectureConverter.md](doc/ArchitectureConverter.md).
156157

157158
If desired, all components of the toolchain can be disabled individually (`disable_doc_gen`for *documentation generation* and `disable_test_cov` for *test coverage evaluation*).
158159
Some recommended additional options would be `--project_number` and `--project_brief`.

0 commit comments

Comments
 (0)