Skip to content

Add protobuf exporter include comments option #491

Open
JohannSchramm wants to merge 1 commit intoCOVESA:masterfrom
toni-experience-software:protobuf-desc
Open

Add protobuf exporter include comments option #491
JohannSchramm wants to merge 1 commit intoCOVESA:masterfrom
toni-experience-software:protobuf-desc

Conversation

@JohannSchramm
Copy link

This PR adds the --include-comments flag to the protobuf exporter.
If provided, the exporter will now generate matching protobuf comments, built from their respective descriptions and other available data, into the resulting .proto.

My main motivation for this feature was to allow the then further generated target language code to include these comments, especially the description, as well.

@JohannSchramm JohannSchramm force-pushed the protobuf-desc branch 4 times, most recently from 46d7253 to 5767807 Compare March 12, 2026 20:12
Signed-off-by: Johann Schramm <43448334+JohannSchramm@users.noreply.github.com>
@erikbosch
Copy link
Collaborator

Thank for the PR. Great to see that you have updated tests and documentation. We will follow or normal process, presenting at the VSS meeting at Wednesday and then give people time to review for a week.

Media.Played.Source:
datatype: string
type: actuator
allowed: ['UNKNOWN', 'SIRIUS_XM', 'AM', 'FM', 'DAB', 'TV', 'CD', 'DVD', 'AUX', 'USB', 'DISK', 'BLUETOOTH', 'INTERNET', 'VOICE', 'BEEP']
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't the translation of allowed be using a protobuf enum?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR and these docs represents the current state of the protobuf generator.

However I agree, that would probably be the logical next step to use protobuf enums for this.

I've created an Issue for this: #493

@erikbosch
Copy link
Collaborator

MoM:

  • Please review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants