The comment enumeration tool will help developers by creating headers and maintaining the index labels for comments as described in the documentation standards.
Add the comment enumeration tool inside the repository. It could be located in a subdirectory of the src folder. Avoid adding it to an existing directory in src to prevent mixing separate programs.
Update the Makefiles to include a rule for running the enumerator on all of the source files. The standards for this requirement aren't super rigorous: it should just be simple and convenient. There should be at least one rule to run the tool on all of the code in the src folders. Potentially there could be wildcard rules to target individual source files, but if developers can easily target individual files by running the enumerator directly, there is no need. Depending on the specific implementation, the rule to run the tool on all of the src folders could also use a wildcard rule (like having a dependency on the comment rule for $(SOURCES) and thus causing the tool to run on all of them).
The comment enumeration tool will help developers by creating headers and maintaining the index labels for comments as described in the documentation standards.
Add the comment enumeration tool inside the repository. It could be located in a subdirectory of the src folder. Avoid adding it to an existing directory in src to prevent mixing separate programs.
Update the Makefiles to include a rule for running the enumerator on all of the source files. The standards for this requirement aren't super rigorous: it should just be simple and convenient. There should be at least one rule to run the tool on all of the code in the src folders. Potentially there could be wildcard rules to target individual source files, but if developers can easily target individual files by running the enumerator directly, there is no need. Depending on the specific implementation, the rule to run the tool on all of the src folders could also use a wildcard rule (like having a dependency on the comment rule for
$(SOURCES)and thus causing the tool to run on all of them).