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.