[jira] Assigned: (AXISCPP-169) Incomplete documentation of Public API

["Fred Preston (JIRA)" <ax...@ws.apache.org>]

     [ http://issues.apache.org/jira/browse/AXISCPP-169?page=history ]

Fred Preston reassigned AXISCPP-169:
------------------------------------

    Assign To:     (was: Fred Preston)

These problems are outside the scope of the documentation I am currently writing.

> Incomplete documentation of Public API
> --------------------------------------
>
>          Key: AXISCPP-169
>          URL: http://issues.apache.org/jira/browse/AXISCPP-169
>      Project: Axis-C++
>         Type: Improvement
>   Components: Documentation
>     Versions: current (nightly)
>     Reporter: Adrian Dick
>     Priority: Minor

>
> When running Doxygen for the Public API (ie ws-axis/c/include/axis) a significant portion of the API is undocumented.
> Below are the warnings as seen running when running Doxygen (these are from Windows, but similar on Linux):
> C:/CWSS/development/src/ws-axis/c/include/axis/AxisGenException.h:56: Warning: Example throw was already documented. Ignoring documentation found here.
> C:/CWSS/development/src/ws-axis/c/include/axis/AxisGenException.h:68: Warning: Example throw was already documented. Ignoring documentation found here.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisException.h:166: Warning: Example throw was already documented. Ignoring documentation found here.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisException.h:178: Warning: Example throw was already documented. Ignoring documentation found here.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisException.h:189: Warning: Example throw was already documented. Ignoring documentation found here.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/BasicNode.h:72: Warning: Compound BasicNodeFunctions is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IWrapperSoapDeSerializer.h:145: Warning: Compound IWrapperSoapDeSerializer_C is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/Packet.h:61: Warning: Compound Ax_header is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/BasicHandler.h:37: Warning: Compound BasicHandlerFunctions is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IMessageData.h:40: Warning: Compound IMessageDataFunctions is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IHandlerSoapDeSerializer.h:85: Warning: Compound IHandlerSoapDeSerializer is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IHandlerSoapDeSerializer.h:44: Warning: Compound IHandlerSoapDeSerializer is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IParam.h:54: Warning: Compound uParamValue is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/BasicHandler.h:47: Warning: Compound BasicHandler is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/client/Call.h:627: Warning: Compound Call is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/ISoapSerializer.h:31: Warning: Compound ISoapSerializer is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/BasicNode.h:294: Warning: Compound BasicNode_C is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/BasicNode.h:83: Warning: Compound BasicNode is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/client/Call.h:78: Warning: Compound CallFunctions is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/AxisGenException.h:33: Warning: Compound AxisGenException is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IMessageData.h:49: Warning: Compound IMessageData_C is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/client/Stub.h:700: Warning: Compound Call_C is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/Packet.h:234: Warning: Compound BufferInfo is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IHeaderBlock.h:346: Warning: Compound HeaderBlock_C is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IWrapperSoapSerializer.h:29: Warning: Compound IWrapperSoapSerializerFunctions is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IWrapperSoapDeSerializer.h:30: Warning: Compound IWrapperSoapDeSerializerFunctions is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IParam.h:77: Warning: Compound IParam is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/client/Call.h:241: Warning: Compound CallBase is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/Attribute.h:61: Warning: Compound AttributeFunctions is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IMessageData.h:67: Warning: Compound IMessageData is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/ISoapDeSerializer.h:30: Warning: Compound ISoapDeSerializer is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IWrapperSoapSerializer.h:96: Warning: Compound IWrapperSoapSerializer_C is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/ISoapHeader.h:31: Warning: Compound ISoapHeader is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/SoapEnvVersions.h:74: Warning: Compound SoapEnvVersionsStruct is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IWrapperSoapSerializer.h:118: Warning: Compound IWrapperSoapSerializer is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/Attribute.h:110: Warning: Compound Attribute_C is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IParam.h:37: Warning: Compound ComplexObjectHandler is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IHeaderBlock.h:68: Warning: Compound HeaderBlockFunctions is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:210: Warning: documented function `_array Contains an array of xml encoded AnyType::strings' was not defined.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IHandlerSoapSerializer.h:25: Warning: documented function `AXIS_CPP_NAMESPACE_START class' was not defined.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IHeaderBlock.h:28: Warning: documented function `AXIS_CPP_NAMESPACE_START class' was not defined.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/IMessageData.h:26: Warning: documented function `AXIS_CPP_NAMESPACE_START class' was not defined.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/Packet.h:206: Warning: member with no name found.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/SoapEnvVersions.h:69: Warning: documented function `AXIS_CPP_NAMESPACE_START class' was not defined.
> C:/CWSS/development/src/ws-axis/c/include/axis/client/Call.h:65: Warning: documented function `AXIS_CPP_NAMESPACE_START class' was not defined.
> C:/CWSS/development/src/ws-axis/c/include/axis/AxisGenException.h:53: Warning: included file throw is not found. Check your EXAMPLE_PATH
> C:/CWSS/development/src/ws-axis/c/include/axis/server/Attribute.h:118: Warning: Member Attribute of file Attribute.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisException.h:47: Warning: Member AXISC_EXCEPTIONS of file AxisException.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:192: Warning: Member AXIS_CHANNEL_TYPE of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:166: Warning: Member AXIS_DEFINED_ARRAY(void) Axis_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:167: Warning: Member AXIS_DEFINED_ARRAY(xsd__string) xsd__string_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:168: Warning: Member AXIS_DEFINED_ARRAY(xsd__integer) xsd__integer_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:170: Warning: Member AXIS_DEFINED_ARRAY(xsd__long) xsd__long_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:171: Warning: Member AXIS_DEFINED_ARRAY(xsd__short) xsd__short_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:172: Warning: Member AXIS_DEFINED_ARRAY(xsd__decimal) xsd__decimal_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:173: Warning: Member AXIS_DEFINED_ARRAY(xsd__float) xsd__float_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:174: Warning: Member AXIS_DEFINED_ARRAY(xsd__double) xsd__double_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:175: Warning: Member AXIS_DEFINED_ARRAY(xsd__boolean) xsd__boolean_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:176: Warning: Member AXIS_DEFINED_ARRAY(xsd__QName) xsd__QName_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:177: Warning: Member AXIS_DEFINED_ARRAY(xsd__dateTime) xsd__dateTime_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:178: Warning: Member AXIS_DEFINED_ARRAY(xsd__unsignedByte) xsd__unsignedByte_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:179: Warning: Member AXIS_DEFINED_ARRAY(xsd__unsignedInt) xsd__unsignedInt_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:180: Warning: Member AXIS_DEFINED_ARRAY(xsd__unsignedLong) xsd__unsignedLong_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:181: Warning: Member AXIS_DEFINED_ARRAY(xsd__unsignedShort) xsd__unsignedShort_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:182: Warning: Member AXIS_DEFINED_ARRAY(xsd__base64Binary) xsd__base64Binary_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:183: Warning: Member AXIS_DEFINED_ARRAY(xsd__hexBinary) xsd__hexBinary_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:184: Warning: Member AXIS_DEFINED_ARRAY(xsd__anyURI) xsd__anyURI_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/AxisUserAPI.h:185: Warning: Member AXIS_DEFINED_ARRAY(xsd__NMTOKEN) xsd__NMTOKEN_Array of file AxisUserAPI.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/BasicHandler.h:34: Warning: Member HANDLER_TYPE of file BasicHandler.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/BasicNode.h:45: Warning: Member NODE_TYPE of file BasicNode.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/server/BasicNode.h:302: Warning: Member BasicNode of file BasicNode.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/client/Call.h:848: Warning: Member getStubObject(AXIS_PROTOCOL_TYPE nProtocol, AxisChar *pchEndpointURI) of file Call.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/client/Call.h:849: Warning: Member destroyStubObject(void *pCall) of file Call.h is not documented.
> C:/CWSS/development/src/ws-axis/c/include/axis/client/Stub.h:708: Warning: Member Call of file Stub.h is not documented.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira