API review

Proposer: your name here

Present at review:

  • List reviewers

Question / concerns / comments

Enter your thoughts on the API and any questions / concerns you have here. Please sign your name. Anything you want to address in the API review should be marked down here before the start of the meeting.

  • Josh
    • Not API review material per se, but the docs are in the wrong place (doxygen instead of wiki)
    • Your example for using '/' to separate names uses '\'
    • The DiagnosticAnalyzer::analyze function doesn't have enough documentation to know how to use it.

    • DiagnosticItem::toStatusMsg automatically marking it as "checked" seems a bit strange. Also, why "checked"? "checked" here seems like it should be "marked" or "used", or something similar.

    • DiagnosticItem::update should tell you somehow if it fails to update the status.

    • Would be nice if all the raw pointers were shared pointers. I can see analyzers wanting to hold on to previous Status messages for example, to do analysis over time.
    • Why are the different pieces in different namespaces? They should all be in the diagnostic_aggregator namespace.
    • Similarly, why is everything prepended by "Diagnostics"? Why not diagnostics_aggregator::Aggregator/Analyzer/Item?

Meeting agenda

To be filled out by proposer based on comments gathered during API review period


Package status change mark change manifest)

  • /!\ Action items that need to be taken.

  • {X} Major issues that need to be resolved

Wiki: diagnostic_aggregator/Reviews/2009-09-23_API_Review (last edited 2009-09-23 22:10:44 by JoshFaust)