Skip to content

Conversation

@kv2019i
Copy link
Collaborator

@kv2019i kv2019i commented Sep 7, 2020

Add a "ABImajor.minor" note to inline documentation of all
ABI interfaces that have been added or modified as part of
3.17 interface changes.

This is patch serves as an example for proposed new policy on this topic, making the annotations mandatory for any new change:
thesofproject/sof-docs#283

Copy link
Member

@lgirdwood lgirdwood left a comment

Choose a reason for hiding this comment

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

Thanks @kv2019i - this is also a reminder for me to check this in PRs.

@marc-hb
Copy link
Collaborator

marc-hb commented Sep 7, 2020

Any reason not to convert modified comments to doxygen syntax too?

@lgirdwood
Copy link
Member

@kv2019i ping

@lgirdwood lgirdwood added this to the v1.6 milestone Sep 10, 2020
@kv2019i
Copy link
Collaborator Author

kv2019i commented Sep 10, 2020

@marc-hb wrote:

Any reason not to convert modified comments to doxygen syntax too?

Not really. I don't see we actually generate doxygen output from these and thus I just used existing conventions of using

  /* simple comment when before a field */
  struct foobar;

  int barfield; /**< doxygen style when after the field */

But yeah, why existings docs are like this, I don't really know.

Add a "ABImajor.minor" note to inline documentation of all
ABI interfaces that have been added or modified as part of
3.17 interface changes.

Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
@kv2019i kv2019i force-pushed the topic/abi-document-3.17-changed-fields branch from f0cf635 to d1135c1 Compare September 11, 2020 13:16
@kv2019i
Copy link
Collaborator Author

kv2019i commented Sep 11, 2020

@marc-hb Now updated. I converted all comments to doxygen style and verified from doxygen output that the documentation actually ends up there. It's not included in our public website docs, but at least it's there if someone generates the local documentation.

@lgirdwood lgirdwood merged commit 73bd5c6 into thesofproject:master Sep 14, 2020
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