Extract field comments

Author: csnewman

enums.gen.go

@@ -2475,8 +2475,8 @@ const (
 	AVChanAmbisonicBase AVChannel = C.AV_CHAN_AMBISONIC_BASE
 	// AVChanAmbisonicEnd wraps AV_CHAN_AMBISONIC_END.
 	/*
-	   // leave space for 1024 ids, which correspond to maximum order-32 harmonics,
-	   // which should be enough for the foreseeable use cases
+	   leave space for 1024 ids, which correspond to maximum order-32 harmonics,
+	   which should be enough for the foreseeable use cases
 	*/
 	AVChanAmbisonicEnd AVChannel = C.AV_CHAN_AMBISONIC_END
 )
@@ -3109,16 +3109,16 @@ const (
 
 	   @code{.c}
 	   av_rescale_rnd(3, 1, 2, AV_ROUND_UP | AV_ROUND_PASS_MINMAX);
-	   // Rescaling 3:
-	   //     Calculating 3 * 1 / 2
-	   //     3 / 2 is rounded up to 2
-	   //     => 2
+	   Rescaling 3:
+	       Calculating 3 * 1 / 2
+	       3 / 2 is rounded up to 2
+	       => 2
 
 	   av_rescale_rnd(AV_NOPTS_VALUE, 1, 2, AV_ROUND_UP | AV_ROUND_PASS_MINMAX);
-	   // Rescaling AV_NOPTS_VALUE:
-	   //     AV_NOPTS_VALUE == INT64_MIN
-	   //     AV_NOPTS_VALUE is passed through
-	   //     => AV_NOPTS_VALUE
+	   Rescaling AV_NOPTS_VALUE:
+	       AV_NOPTS_VALUE == INT64_MIN
+	       AV_NOPTS_VALUE is passed through
+	       => AV_NOPTS_VALUE
 	   @endcode
 	*/
 	AVRoundPassMinmax AVRounding = C.AV_ROUND_PASS_MINMAX
@@ -3565,7 +3565,7 @@ const (
 	AVPixFmtGbrp AVPixelFormat = C.AV_PIX_FMT_GBRP
 	// AVPixFmtGbr24P wraps AV_PIX_FMT_GBR24P.
 	//
-	//	// alias for #AV_PIX_FMT_GBRP
+	//	alias for #AV_PIX_FMT_GBRP
 	AVPixFmtGbr24P AVPixelFormat = C.AV_PIX_FMT_GBR24P
 	// AVPixFmtGbrp9Be wraps AV_PIX_FMT_GBRP9BE.
 	//

functions.gen.go

@@ -9669,14 +9669,14 @@ func AVFree(ptr unsafe.Pointer) {
   @code{.c}
   uint8_t *buf = av_malloc(16);
   av_free(buf);
-  // buf now contains a dangling pointer to freed memory, and accidental
-  // dereference of buf will result in a use-after-free, which may be a
-  // security risk.
+  buf now contains a dangling pointer to freed memory, and accidental
+  dereference of buf will result in a use-after-free, which may be a
+  security risk.
 
   uint8_t *buf = av_malloc(16);
   av_freep(&buf);
-  // buf is now NULL, and accidental dereference will only result in a
-  // NULL-pointer dereference.
+  buf is now NULL, and accidental dereference will only result in a
+  NULL-pointer dereference.
   @endcode
 
   @param ptr Pointer to the pointer to the memory block which should be freed

internal/generator/file.go

@@ -53,6 +53,7 @@ type Field struct {
 	Name     string
 	Type     Type
 	BitWidth int32
+	Comment  string
 }
 
 type Enum struct {

internal/generator/generator.go

@@ -646,6 +646,11 @@ func (g *Generator) generateStructs() {
 			}
 
 			o.Commentf("%v gets the %v field.", fName, field.Name)
+
+			if field.Comment != "" {
+				o.Comment(field.Comment)
+			}
+
 			o.Func().
 				Params(jen.Id("s").Op("*").Id(goName)).
 				Id(fName).
@@ -657,6 +662,11 @@ func (g *Generator) generateStructs() {
 
 			if len(setBody) > 0 {
 				o.Commentf("Set%v sets the %v field.", fName, field.Name)
+
+				if field.Comment != "" {
+					o.Comment(field.Comment)
+				}
+
 				o.Func().
 					Params(jen.Id("s").Op("*").Id(goName)).
 					Id(fmt.Sprintf("Set%v", fName)).

internal/generator/parser.go

@@ -292,6 +292,8 @@ func processComment(in string) string {
 		s = strings.TrimPrefix(s, "* ")
 		s = strings.TrimPrefix(s, "/// ")
 		s = strings.TrimPrefix(s, "///")
+		s = strings.TrimPrefix(s, "// ")
+		s = strings.TrimPrefix(s, "//")
 
 		if strings.HasPrefix(s, "/**") {
 			rebuilt = nil
@@ -501,6 +503,8 @@ func (p *Parser) parseStruct(indent string, c clang.Cursor, typedef bool) {
 				log.Fatal("no field name")
 			}
 
+			cmt := processComment(cursor.RawCommentText())
+
 			fIndent := fmt.Sprintf("%v[%v]", indent, name)
 
 			ty := p.parseType(fIndent, cursor.Type())
@@ -509,6 +513,7 @@ func (p *Parser) parseStruct(indent string, c clang.Cursor, typedef bool) {
 				Name:     name,
 				Type:     ty,
 				BitWidth: cursor.FieldDeclBitWidth(),
+				Comment:  cmt,
 			})
 		}