Skip to content

Commit

Permalink
Update documentation comments
Browse files Browse the repository at this point in the history
  • Loading branch information
alchemistmatt committed Oct 23, 2024
1 parent 051e8c2 commit 9507dea
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -733,7 +733,7 @@ private string ConstructKeyForPSM(ToolResultsBaseClass additionalResult)
}

/// <summary>
/// This routine creates a synopsis file from the output from MSFragger (file Dataset_psm.tsv or Dataset.tsv)
/// This routine creates a synopsis file from the output from MSFragger (or FragPipe) results file (e.g., Dataset.tsv, Dataset_psm.tsv, ExperimentGroup_psm.tsv)
/// The synopsis file includes every result with a probability above a set threshold
/// </summary>
/// <param name="inputFilePath">MSFragger results file</param>
Expand Down Expand Up @@ -2288,7 +2288,7 @@ private bool ParseMSFraggerSynFileEntry(
/// <summary>
/// Main processing routine
/// </summary>
/// <param name="inputFilePath">MSFragger results file (Dataset_psm.tsv or Dataset.tsv)</param>
/// <param name="inputFilePath">MSFragger (or FragPipe) results file (e.g., Dataset.tsv, Dataset_psm.tsv, ExperimentGroup_psm.tsv)</param>
/// <param name="outputDirectoryPath">Output directory</param>
/// <param name="parameterFilePath">Parameter file</param>
/// <returns>True if successful, False if failure</returns>
Expand Down Expand Up @@ -2431,7 +2431,7 @@ public override bool ProcessFile(string inputFilePath, string outputDirectoryPat
}

/// <summary>
/// Load MSFragger search results
/// Load MSFragger (or FragPipe) search results
/// </summary>
/// <remarks>If the file is found, but has no results, this method still returns true</remarks>
/// <param name="inputFile">Dataset.tsv, Dataset_psm.tsv, or Aggregation_psm.tsv file</param>
Expand Down

0 comments on commit 9507dea

Please sign in to comment.