ndsev / zserio

zero sugar, zero fat, zero serialization overhead
https://zserio.org/
BSD 3-Clause "New" or "Revised" License
109 stars 27 forks source link

Doc Strings Missing for 'extend' Fields in HTML Documentation #668

Open MisterGC opened 2 hours ago

MisterGC commented 2 hours ago

Fields defined with the extend keyword in a zserio schema are missing their doc strings in the generated HTML documentation.

Steps to Reproduce:

  1. Create a zserio schema with extend fields, including doc strings.
  2. Generate the HTML documentation.
  3. Observe that the doc strings for extend fields are absent.

Example Schema:

struct SomeStruct
{
    /** Some data. */
    ExampleType exampleType;

    /** Some additional data.*/
    extend optional ExampleExtension exampleExtension;
}

Zserio Version: 2.15.0 Generated HTML: The doc string for exampleExtension is missing. Expected Behavior: Doc strings for extend fields should appear in the generated HTML documentation.

mikir commented 1 hour ago

OK, thanks to point this out. I will put it to the current milestone.