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

Create annotation for citations #8

Closed
felixreimann opened this issue Mar 12, 2018 · 2 comments
Closed

Create annotation for citations #8

felixreimann opened this issue Mar 12, 2018 · 2 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@felixreimann
Copy link
Collaborator

felixreimann commented Mar 12, 2018

A @citation annotation shall hold information for citations for a specific class.

When an optimization is started, all used classes with @citation could be gathered and, as an information, printed out to the logger.

The GUI could show them.

@felixreimann felixreimann added enhancement New feature or request good first issue Good for newcomers labels Mar 12, 2018
@felixreimann felixreimann self-assigned this Mar 12, 2018
@michaelhglass
Copy link
Member

Possible list of features:

  • Multiple citations per class/element required (careful since multiple annotations of the same type requires Java 8 - otherwise a @Citations might be required with nested @citation)
  • The respective representation of the annotation should follow one internationally accepted style like Harvard etc. I would suggest relying on the programmer to adhere to a certain simple style and not integrate a full-fledged BibTeX/Biber parser
  • Citation should also find its way into the documentation without duplicating entries in the comment

@felixreimann
Copy link
Collaborator Author

Regarding your first point: I think it is time to upgrade to Java 9. Thus, another @Citations is not necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants