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

Field comments in each object #110

Open
acesnik opened this issue Feb 28, 2017 · 1 comment
Open

Field comments in each object #110

acesnik opened this issue Feb 28, 2017 · 1 comment

Comments

@acesnik
Copy link
Collaborator

acesnik commented Feb 28, 2017

Each object should have some sort of metadata that explains the fields in each object. One example: "accession" in ModificationWithLocation is a Tuple<string, string>, but it's not clear unless looking at the mzLib code what each string represents.

@stefanks
Copy link
Collaborator

To get this working, need to compile with /doc command
https://msdn.microsoft.com/en-us/library/3260k4x7.aspx
And then to make sure the generated XML file is included in the nuget package. Here are the projects this needs to be done on:

  • Chemistry
  • mzIdentML
  • MzML
  • Thermo
  • MassSpectrometry
  • Proteomics
  • Spectra
  • UsefulProteomicsDatabases
  • MzLibUtil

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

2 participants