search

smith-chem-wisc / mzLib

Library for mass spectrometry projects
GNU Lesser General Public License v3.0
26 stars 33 forks source link

Field comments in each object #110

Open acesnik opened 7 years ago

acesnik commented 7 years ago

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 commented 7 years ago

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: