Documentar archivos .H
Adela
14 de Marzo del 2004
Necesito ayuda para documentar tres archivos .H
Por favor ayudenme gracias
Los archivos las funciones de los cuales se tienen que documentar son:
TOBJECT.H
WINSYS.H
TAPLIC.H
Puede haber una breve descripci贸n del objetos enlazados est茅ticamente dentro PCIO.CPP, pero no se considera necesario describir sus funciones miembro.
Funciones miembro que se tienen que documentar, funciones que no ès necesario documentar y funciones que no se tienen que documentar.
Las funciones se tienen que documentar exponiendo:
Su cabecera, su funcionalidad, la naturaleza de cada par谩metro, y el significado del valor devuelto, si hay.
Todo esto sin explicar los detalles de la implementaci贸n. P.E.:
- virtual unsigned int twinsystemm::openframe(tframe *tf):
Funci贸n que pide a la aplicaci贸n que 聲briga la ventana tf, consistente en un puntero a tframe . Dentro la parte solicitant la ventana tiene que consistir en un puntero a tframe o a una clase derivada de tframe al cual ya se le habr谩 reservado memoria din谩mica con new y se le habr谩n incorporado los componentes. S贸lo tras cumplir estos requisitos, se podr谩 gritar openframe. La funci贸n devuelve el estatus de la aplicaci贸n. Si todo ha ido b聜 devolver谩 el valor funcdoy.
Se tienen que documentar:
c.- De TOBJECT.H: - El significado de las constantes de estado, no revelando sus valores.
- De tgraphic: se ha de explicar la finalidad general de todas las funciones, puesto que ser谩n los
m茅todos b谩sicos de todas las clases derivadas. No se han de explicar el constructor ni el destructor.
b.- De WINSYS.H:
- De twinsystem: 煤nicamente openframe().
- De tframe: El constructor y las funciones empezadas con el prefijo siete y con el prefijo d贸nde.
Explicar por qu茅 el destructor tiene que ser virtual. De la parte protected no se ha de explicar
ninguna funci贸n. - No se han de explicar las funciones de las listas twinlist y tcompolist.
a.- De TAPLIC.H:
Todas las funciones, el destructor no hace falta.
Por favor ayudenme gracias
Los archivos las funciones de los cuales se tienen que documentar son:
TOBJECT.H
WINSYS.H
TAPLIC.H
Puede haber una breve descripci贸n del objetos enlazados est茅ticamente dentro PCIO.CPP, pero no se considera necesario describir sus funciones miembro.
Funciones miembro que se tienen que documentar, funciones que no ès necesario documentar y funciones que no se tienen que documentar.
Las funciones se tienen que documentar exponiendo:
Su cabecera, su funcionalidad, la naturaleza de cada par谩metro, y el significado del valor devuelto, si hay.
Todo esto sin explicar los detalles de la implementaci贸n. P.E.:
- virtual unsigned int twinsystemm::openframe(tframe *tf):
Funci贸n que pide a la aplicaci贸n que 聲briga la ventana tf, consistente en un puntero a tframe . Dentro la parte solicitant la ventana tiene que consistir en un puntero a tframe o a una clase derivada de tframe al cual ya se le habr谩 reservado memoria din谩mica con new y se le habr谩n incorporado los componentes. S贸lo tras cumplir estos requisitos, se podr谩 gritar openframe. La funci贸n devuelve el estatus de la aplicaci贸n. Si todo ha ido b聜 devolver谩 el valor funcdoy.
Se tienen que documentar:
c.- De TOBJECT.H: - El significado de las constantes de estado, no revelando sus valores.
- De tgraphic: se ha de explicar la finalidad general de todas las funciones, puesto que ser谩n los
m茅todos b谩sicos de todas las clases derivadas. No se han de explicar el constructor ni el destructor.
b.- De WINSYS.H:
- De twinsystem: 煤nicamente openframe().
- De tframe: El constructor y las funciones empezadas con el prefijo siete y con el prefijo d贸nde.
Explicar por qu茅 el destructor tiene que ser virtual. De la parte protected no se ha de explicar
ninguna funci贸n. - No se han de explicar las funciones de las listas twinlist y tcompolist.
a.- De TAPLIC.H:
Todas las funciones, el destructor no hace falta.