The XML description in LLRPdef.xml currently features an annotation element
that references the corresponding section in the LLRP spec. I think this is
very helpful because it speeds up searching through the LLRP spec.
>From a code documentation perspective, it might be even useful to not only
include the reference but the actual description in the LLRP specification.
This would allow us to generate the code documentation directly from the
LLRPdef.xml.
Currently:
<messageDefinition name="GET_READER_CAPABILITIES" typeNum="1">
<annotation>
<documentation>
reference 9.1.1 and 16.1.1
</documentation>
</annotation>
<field type="u8" name="RequestedData"
enumeration="GetReaderCapabilitiesRequestedData"/>
<parameter repeat="0-N" type="Custom"/>
</messageDefinition>
Proposed:
<messageDefinition name="GET_READER_CAPABILITIES" typeNum="1">
<annotation>
<documentationRef>
reference 9.1.1 and 16.1.1
</documentationRef>
<documentation>
This message is sent from the Client to the Reader. The
Client is able to request only a subset or all the
capabilities from the Reader.
</documentation>
</annotation>
<field type="u8" name="RequestedData"
enumeration="GetReaderCapabilitiesRequestedData"/>
<parameter repeat="0-N" type="Custom"/>
</messageDefinition>
Pro:
- we can generate code and the appropriate documentation from the
XML description
Con:
- LLRPdef.xml might become a bit overloaded with documentation.
- Might not be useful for all implementations (I think it would at
least help for an c# and java impl)
Not sure whether this was already considered earlier and rejected.
- Christian
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
llrp-toolkit-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/llrp-toolkit-devel
