Project

General

Profile

Documentation #5305

Feature #5203: Update PvlToXmlTranslationManager to handle latest translation scheme

Inaccurate method documentation for XmlToPvlTranslationManager

Added by Jean Backer over 1 year ago. Updated 5 months ago.

Status:
Acknowledged
Priority:
Normal
Assignee:
-
Category:
API
Target version:
-
Impact:

No impact on programs. Developer documentation only.

Software Version:
Test Reviewer:

Description

The following method has out-dated documentation:

  bool XmlToPvlTranslationManager::checkDependencies(QDomElement element,
                                                     PvlKeyword dependencies,
                                                     bool isDebug) const{

The parsed symbol between name and value should be a vertical bar "|" instead of a colon ":"
This is probably not the correct place to document this since it is not the part of the code that is looking for the parsed value. Perhaps the header or another class is more appropriate so that if changes are made to this in the future, the documentation will be updated with the code change.

History

#1 Updated by Jean Backer over 1 year ago

Also, to comply with coding standards, there should be a space between the closing parenthesis and the opening curly brace in the method declaration.

#2 Updated by Makayla Shepherd over 1 year ago

  • Private changed from No to Yes

#4 Updated by Makayla Shepherd over 1 year ago

  • Status changed from New to Acknowledged

#5 Updated by Stuart Sides 5 months ago

  • Private changed from Yes to No

Also available in: Atom PDF