Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 12c02a63 authored by Jaewoong Jung's avatar Jaewoong Jung
Browse files

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
parent 66184450

cmd/soong_build/writedocs.go

+3 −2
Original line number Diff line number Diff line
@@ -276,8 +276,9 @@ li a:hover:not(.active) { 
    {{- 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}}