search

cn-uofbasel / ccn-lite

CCN-lite, a lightweight implementation of the CCNx protocol and its variations
ISC License
74 stars 63 forks source link

make ccnl-content.h part of doxygen-based API documentation #267

Closed mfrey closed 6 years ago

mfrey commented 6 years ago

Contribution description

This is a "boy scout" pull request. It aims in improving the overall quality of our API documentation. It moved pre-processor statements out of the struct declaration of ccnl_content_s to a fixed-width enum and added documentation to the struct and the two functions declared in the header.

mfrey commented 6 years ago

I'm happy to add a better explanation for the STALE/STATIC constants. Also, can we remove the generic comment in the ccnl_content_s struct

     // NON-CONFORM: "The [ContentSTore] MUST also implement the Staleness Bit."
     // >> CCNL: currently no stale bit, old content is fully removed <<