diff options
| author | Jaewoong Jung <jungjw@google.com> | 2019-03-12 13:28:25 -0700 |
|---|---|---|
| committer | Jaewoong Jung <jungjw@google.com> | 2019-03-12 13:31:11 -0700 |
| commit | 12c02a63d0c3694f74b5c0d808b1d286d0e68f83 (patch) | |
| tree | 63030d8f6ea7dbb958d294c95b53210feaa1eb61 /cmd | |
| parent | 66184450d5765889a5fb71d14c1a44959ebaefbe (diff) | |
| download | build_soong-12c02a63d0c3694f74b5c0d808b1d286d0e68f83.tar.gz build_soong-12c02a63d0c3694f74b5c0d808b1d286d0e68f83.tar.bz2 build_soong-12c02a63d0c3694f74b5c0d808b1d286d0e68f83.zip | |
Build doc improvements.android-q-preview-1
Bring property type strings to the start of property comments. This is
how source.android.com shows variables and paratemeters, and it is also
easier to read, especially when a comment ends with a code example.
Test: m soong_docs
Change-Id: Ic3e9db3a3711495998919ee95bbef6c7cb33b215
Diffstat (limited to 'cmd')
| -rw-r--r-- | cmd/soong_build/writedocs.go | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/cmd/soong_build/writedocs.go b/cmd/soong_build/writedocs.go index 5171b685..d011e77f 100644 --- a/cmd/soong_build/writedocs.go +++ b/cmd/soong_build/writedocs.go @@ -276,8 +276,9 @@ li a:hover:not(.active) { {{- else -}} <div class="simple" id="{{getModule}}.{{.Name}}"> <span class="fixed"> </span><b>{{.Name}} {{range .OtherNames}}, {{.}}{{end -}}</b> - {{- if .Text -}}{{.Text}}{{- end -}} - {{- with .OtherTexts -}}{{.}}{{- end -}}<i>{{.Type}}</i> + <i>{{.Type}}</i> + {{- if .Text -}}{{if ne .Text "\n"}}, {{end}}{{.Text}}{{- end -}} + {{- with .OtherTexts -}}{{.}}{{- end -}} {{- if .Default -}}<i>Default: {{.Default}}</i>{{- end -}} </div> {{- end}} |