need some help with my documentation

[deltamami0999]

can someone help me to document my code quickly?

//Name: Cassi Smith
//Date: March 5, 2008
//Assignment: Chapter 12 Inventory Management System
//Description: This header file makes available the functions that can be reused
by the client and data fields t
#include <string>
using namespace std;
class InventoryItem
{

public:
InventoryItem();
InventoryItem(double UPC, string itemName, int quantity, double price);

double getUPC();
string getItemName();
int getQuantity();
double getPrice();

void setUPC(double UPC);
void setItemName(string itemName);
void setQuantity(int quantity);
void setPrice(double price);

double getValueOfInventoryItem();
void writeItem();

private:
double UPC;
string itemName;
int quantity;
double price;

};

[gpraghuram]

can someone help me to document my code quickly?

//Name: Cassi Smith
//Date: March 5, 2008
//Assignment: Chapter 12 Inventory Management System
//Description: This header file makes available the functions that can be reused
by the client and data fields t
#include <string>
using namespace std;
class InventoryItem
{

public:
InventoryItem();
InventoryItem(double UPC, string itemName, int quantity, double price);

double getUPC();
string getItemName();
int getQuantity();
double getPrice();

void setUPC(double UPC);
void setItemName(string itemName);
void setQuantity(int quantity);
void setPrice(double price);

double getValueOfInventoryItem();
void writeItem();

private:
double UPC;
string itemName;
int quantity;
double price;

};

Try to use doxygen the open source tool to generate the documentation for your code
raghuram

[deltamami0999]

Try to use doxygen the open source tool to generate the documentation for your code
raghuram

what does that mean?

[MACKTEK]

Use google, type in Doxygen, and read how to use it.

Asking someone "is there a program that can assist me to document your work?" results in: use such and such program... for example Doxygen.

Unless of course you really want someone to "document" your work for you, in that case, you are posting in the wrong forum.

If you do not understand what it means to "document" your work, then the answer is: the // creates a comment that is ignored by a program. but allows you to read information about the program.

// This is a program.
// Written by (author's name)

#include <string>
using namespace std;
class InventoryItem         // class definition -- documenting the class
{
 
public:
    InventoryItem();