Opened 10 years ago

Last modified 8 years ago

#11 accepted task

Document classes and methods

Reported by: ibboard Owned by: ibboard
Priority: major Milestone:
Component: WarFoundry-API Version:
Keywords: Cc:
Blocked By: Blocking:

Description

Public methods should be documented so that people know what they do. Documentation should need to be minimal on classes as the method name should be descriptive and small enough to work out what it does, but contracts can sometimes still be best described in documentation.

Change History (7)

comment:1 Changed 10 years ago by ibboard

Status: newaccepted

comment:2 Changed 10 years ago by ibboard

Summary: Document methodsDocument classes and methods

comment:3 Changed 10 years ago by ibboard

(In r20) Re #11 - Documentation

  • Document Stats and SystemStats at class level to explain the difference
  • Document WarFoundryXmlFactory at class level

Re #13 - XPath for XML loading

  • Load categories using XPath - needs fixing so we can do a proper "categories/cat" query

Re #10 - Refactoring for readability

  • Fix method signature for getting number from attribute added in r19
  • Refactor more code in to GetExtraData method
  • Separate out loading of categories for GameSystem

comment:4 Changed 10 years ago by ibboard

(In r41) Re #10 and re #11 - Refactor code and document code

  • Split LoadFile method out in to smaller methods
  • Document possible exception from IWarFoundryFactory object loading method
  • Catch exception in WarFoundryLoader file loading

comment:5 Changed 10 years ago by ibboard

(In r62) Re #11 - Document methods

  • Document FileLoadFailure and rationalise constructors

Also added parameter for holding the Exception that caused the failure

comment:6 Changed 10 years ago by ibboard

(In r81) Re #11 - Document classes and methods

  • Document methods in UnitType and Category classes

comment:7 Changed 8 years ago by ibboard

Component: General/UnknownWarFoundry-API

Most important part for this ticket is the API.

Note: See TracTickets for help on using tickets.