Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update comments in KCNOAACalculator to match framework #160

Open
MosheBerman opened this issue Dec 29, 2023 · 0 comments
Open

Update comments in KCNOAACalculator to match framework #160

MosheBerman opened this issue Dec 29, 2023 · 0 comments

Comments

@MosheBerman
Copy link
Owner

MosheBerman commented Dec 29, 2023

The header comment in some files is using a format inconsistent with the rest of the framework. This issue is about changing the comments to be consistent with the rest of the framework.

Impacted Files

  • KCAstronomicalCalculator.h
  • KCNOAACalculator.h
  • KCNOAACalculator.m

Details

Instead of a series of single line comments, the comment should be a multi-line comment block. For example, this is the ideal format:

/**
 *  KCNOAACalculator.h
 *  KosherCocoa 3
 *
 *  Created by Elyahu on 1/23/23.
 *  Updated by Moshe Berman on 12/29/23.
 *
 *  Use of KosherCocoa 3 is governed by the LGPL 2.1 License.
 */

How To Test

  • Verify the file names and dates are correect after updating the comments.
  • No other automated testing required.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant