Task #4163
closed
Change formatting of license boilerplate
100%
Description
Current license boilerplate starts with /**, which causes Doxygen to parse it as documentation. It should be changed to start with /*.
Updated by Junxiao Shi over 8 years ago
- Status changed from New to Resolved
- Assignee set to Junxiao Shi
- % Done changed from 0 to 60
https://gerrit.named-data.net/4001 ndn-cxx
https://gerrit.named-data.net/3996 NFD
Should this be applied to ndn-tools as well? There is no Doxygen over there.
Updated by Davide Pesavento over 8 years ago
Should this be applied to ndn-tools as well? There is no Doxygen over there.
I'm neutral.
Updated by Junxiao Shi over 8 years ago
- Status changed from Resolved to Closed
- Start date deleted (
07/05/2017) - % Done changed from 60 to 100
I will not enforce /* format in ndn-tools. Only /** format is acceptable in ndn-tools, as specified in README-dev.md.
Updated by Eric Newberry over 8 years ago
Junxiao Shi wrote:
I will not enforce
/*format in ndn-tools. Only/**format is acceptable in ndn-tools, as specified in README-dev.md.
This should applied to ndn-tools for consistency across the project.
Updated by Junxiao Shi over 8 years ago
- Status changed from Closed to In Progress
- Assignee changed from Junxiao Shi to Eric Newberry
This should applied to ndn-tools for consistency across the project.
I can agree with that. However, please do not block https://gerrit.named-data.net/4059 because of this. Let's deal with one change at a time. After 4059 is merged, you may upload a Change updating README-dev.md to specify new format. Once README-dev.md change is merged, all new code must use the new format.
Note that attempting to update README-dev.md before 4059 would be unsuccessful because it would not pass Jenkins.
Updated by Eric Newberry about 8 years ago
- Status changed from In Progress to Code review
Updated by Eric Newberry about 8 years ago
- Status changed from Code review to Closed