|
|
|
| Authored by: Anonymous on Friday, April 27 2012 @ 10:52 PM EDT |
You are NOT a Java programmer, and I doubt a programmer at all.
Thus, I do believe you are ill equipped to discern whether or not JavaDoc output
is exactly like the header files seen in other languages such as C or C++.
Furthermore, I believe it is moronic of you to apply such an analogy in this
instance -- It proves that you totally disregard your own ignorance of the
situation, yet proceed to make statements about it...
Moron n. A stupid person; a dolt.
It's a STUPID analogy you Dolt! Ergo, moronic.[ Reply to This | Parent | # ]
|
| |
| Authored by: Anonymous on Friday, April 27 2012 @ 11:25 PM EDT |
I am the anonymous you're talking about.
Here is an except from one of my C header files: core/buffer.c
/***************************************************************************//**
@struct Buffer_F
Buffer Forms encapsulate a series of bytes in memory and provide actions to
manipulate the data. The capacity of a Buffer's data may be fixed, or allowed
to grow as needed.
*******************************************************************************/
struct Buffer_F
{
/// Extends the base Entity Form.
Entity_F base;
//--------------------------------------------------------------------------
/// Read one byte at the marker, and advance the marker by one byte. If a
/// byte is requested beyond the limit it will not be read.
///
/// @return 1 if a byte was read, -1 on error, or 0 if the marker is
/// beyond the limit.
///
cs_sint32
(*/***************************************************************************//
**
@struct Buffer_F
Buffer Forms encapsulate a series of bytes in memory and provide actions to
manipulate the data. The capacity of a buffer's data may be fixed, or allowed
to grow as needed.
*******************************************************************************/
struct Buffer_F
{
/// Extends the base Entity Form.
Entity_F base;
//--------------------------------------------------------------------------
/// Read one byte at the marker, and advance the marker by one byte. If a
/// byte is requested beyond the limit it will not be read.
///
/// @return 1 if a byte was read, -1 on error, or 0 if the marker is
/// beyond the limit.
///
cs_sint32 (*getByte)
(
/// Buffer Entity to read from.
void *const buffer,
/// Location to store the byte value.
cs_uint8 *const byte
);
/// Location to store the byte value.
cs_uint8 *const byte
);
The header file is marked up with JavaDoc style comments.
The resulting Javadoc output contains ALL of the data in my header file in a
different form (HTML, PDF or Latex), though I use Doxygen as an alternative to
Javadoc.
I can run Javadoc across my C header files (with small modification to make them
more Javalike, and paste the .c file into the .h file), and Javadoc will
extcract ONLY the data that is nomally my header files, nothing of the source
implementation files will be present. I know this for a FACT, because I often
use different variable names in the implementation files, and Doxygen didn't
always exist, so I actually used Javadoc to produce the API documentation for my
C programs.
For instance, the .HTML documentation (API) will contain the "buffer"
and "byte" names in method signature form the .h header:
(*getByte)( void *const buffer, cs_uint8 *const byte);
The signature must be restated in the C implementation code, but the variable
names may be different, since in C the parameter names are ignored (and are
optional) in a .H forward declaration.
In the .C implementation code I actually use this signature:
F_Buffer_getByte( void *const buf, cs_uint8 *const dat ){
...
}
The function is statically assigned to a the Buffer Entity's member function
pointer. (Entity is my version of an object -- Yes, Object Oriented C code)
The terms "buf" and "dat" never appear in the Javadoc or
Doxygen output... This is because Javadoc extracts ONLY what would otherwise be
in a HEADER FILE.
You CLEARLY don't have ANY idea about what you're talking.
You may continue to blab about things you're woefully uneducated about, and
present yourself as knowledgeable, but don't expect others not to call such
behavior what it is... moronic.
[ Reply to This | Parent | # ]
|
|
|
|
|
