Project

General

Profile

Documentation #4121

FileName API Documentation Lacking

Added by Ian Humphrey over 1 year ago. Updated 4 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
API
Target version:
Impact:

Documentation will be updated

Test Reviewer:

Description

The FileName class does not have much documentation present. Since this class should be used when handling file names and paths, more documentation would ensure both more usage of the class and proper usage of the class.

History

#1 Updated by Tammy Becker over 1 year ago

  • Status changed from New to Acknowledged

#2 Updated by Stuart Sides 8 months ago

  • Status changed from Acknowledged to Assigned
  • Assignee set to Cole Neubauer
  • Target version set to 3.5.1 (Sprint 1)
  • Software Version set to 3.5.0 (FY17-patch 2017-04-07 Apr)

#3 Updated by Cole Neubauer 8 months ago

  • Impact updated (diff)

#4 Updated by Cole Neubauer 8 months ago

  • Status changed from Assigned to Resolved

#5 Updated by Ian Humphrey 8 months ago

  • Status changed from Resolved to Code Review

#6 Updated by Ian Humphrey 8 months ago

  • Status changed from Code Review to Feedback

Looks good! In your history comment, add "Fixes #4121." to the end of it.

Suggestions:

  • I would put two lines of whitespace between the methods in the header.

  • FileName::dir() description says "Returns the path of the files parent...", files should be file's

  • FileName::expanded() description may be easier to read of broken into more than one sentence.

  • Although not part of the API, quickly document the private methods as well

#7 Updated by Cole Neubauer 8 months ago

  • Status changed from Feedback to Resolved

#8 Updated by Ian Humphrey 8 months ago

  • Status changed from Resolved to Closed

Looks good!

#9 Updated by Stuart Sides 4 months ago

  • Target version changed from 3.5.1 (Sprint 1) to 3.5.1 (2017-08-08 Aug)

Also available in: Atom PDF