Project

General

Profile

Actions

Task #4163

closed

Change formatting of license boilerplate

Added by Junxiao Shi over 7 years ago. Updated over 7 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Docs
Target version:
Start date:
Due date:
% Done:

100%

Estimated time:

Description

Current license boilerplate starts with /**, which causes Doxygen to parse it as documentation. It should be changed to start with /*.

Actions #1

Updated by Junxiao Shi over 7 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.

Actions #2

Updated by Davide Pesavento over 7 years ago

Should this be applied to ndn-tools as well? There is no Doxygen over there.

I'm neutral.

Actions #3

Updated by Davide Pesavento over 7 years ago

  • Description updated (diff)
Actions #4

Updated by Junxiao Shi over 7 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.

Actions #5

Updated by Eric Newberry over 7 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.

Actions #6

Updated by Junxiao Shi over 7 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.

Actions #7

Updated by Eric Newberry over 7 years ago

  • Status changed from In Progress to Code review
Actions #8

Updated by Eric Newberry over 7 years ago

  • Status changed from Code review to Closed
Actions

Also available in: Atom PDF