commit 12c02a63d0c3694f74b5c0d808b1d286d0e68f83
author Jaewoong Jung <jungjw@google.com> Tue Mar 12 13:28:25 2019 -0700
committer Jaewoong Jung <jungjw@google.com> Tue Mar 12 13:31:11 2019 -0700
tree 63030d8f6ea7dbb958d294c95b53210feaa1eb61
parent 66184450d5765889a5fb71d14c1a44959ebaefbe

Build doc improvements.

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

cmd/soong_build/writedocs.go

diff --git a/cmd/soong_build/writedocs.go b/cmd/soong_build/writedocs.go
index 5171b68..d011e77 100644
--- a/cmd/soong_build/writedocs.go
+++ b/cmd/soong_build/writedocs.go
@@ -276,8 +276,9 @@
     {{- else -}}
       <div class="simple" id="{{getModule}}.{{.Name}}">
         <span class="fixed">&nbsp;</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}}