mirror of
https://github.com/jlengrand/error-prone-support.git
synced 2026-03-10 08:11:25 +00:00
Style summary, and support explanations
This commit is contained in:
@@ -149,7 +149,7 @@
|
||||
-bug_patterns=${basedir}/../error-prone-contrib/target/generated-sources/annotations/bugPatterns.txt
|
||||
</argument>
|
||||
<argument>-docs_repository=${basedir}/target/generated-wiki/</argument>
|
||||
<argument>-explanations=${basedir}/../docs/bugpattern-temp/</argument>
|
||||
<argument>-explanations=${basedir}/../docs/bugpatterns/</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
|
||||
@@ -13,8 +13,12 @@ To make changes, edit the @BugPattern annotation or the explanation in docs/bugp
|
||||
|
||||
{{{severity}}}
|
||||
{{{tags}}}
|
||||
|
||||
{: .summary }
|
||||
{{{summary}}}
|
||||
|
||||
{{{explanation}}}
|
||||
|
||||
{{#suppression}}
|
||||
## Suppression
|
||||
{{{suppression}}}
|
||||
@@ -47,5 +51,3 @@ To make changes, edit the @BugPattern annotation or the explanation in docs/bugp
|
||||
<use xlink:href="#svg-external-link"></use>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
@@ -47,7 +47,7 @@ generate_bugpattern_docs() {
|
||||
# This will create markdown files for each bug pattern in `docgen/target/generated-wiki/bugpatterns`
|
||||
mvn -P run-annotation-processor compile site -Dverification.skip
|
||||
|
||||
cp -R docgen/target/generated-wiki/bugpatterns/ website/
|
||||
cp -r docgen/target/generated-wiki/bugpatterns/*.md website/bugpatterns
|
||||
}
|
||||
|
||||
generate_refaster_docs() {
|
||||
|
||||
@@ -23,6 +23,14 @@ permalink: pretty # Use /doc/ vs. /doc.html
|
||||
search_enabled: true
|
||||
heading_anchors: true
|
||||
|
||||
callouts:
|
||||
summary:
|
||||
title: Summary
|
||||
color: blue
|
||||
warning:
|
||||
title: Warning
|
||||
color: red
|
||||
|
||||
nav_external_links:
|
||||
- title: Error Prone Support on GitHub
|
||||
url: https://github.com/PicnicSupermarket/error-prone-support
|
||||
|
||||
Reference in New Issue
Block a user