keywords.dox 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. /*!\page rfc2119 RFC2119 Keywords
  2. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
  3. NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
  4. "OPTIONAL" in this document are to be interpreted as described in
  5. <a href="http://www.ietf.org/rfc/rfc2119.txt">RFC 2119.</a>
  6. Specifically, the following definitions are used:
  7. \section MUST
  8. \anchor REQUIRED
  9. \anchor SHALL
  10. This word, or the terms "REQUIRED" or "SHALL", mean that the
  11. definition is an absolute requirement of the specification.
  12. \section MUSTNOT MUST NOT
  13. \anchor SHALLNOT
  14. This phrase, or the phrase "SHALL NOT", mean that the
  15. definition is an absolute prohibition of the specification.
  16. \section SHOULD
  17. \anchor RECOMMENDED
  18. This word, or the adjective "RECOMMENDED", mean that there
  19. may exist valid reasons in particular circumstances to ignore a
  20. particular item, but the full implications must be understood and
  21. carefully weighed before choosing a different course.
  22. \section SHOULDNOT SHOULD NOT
  23. \anchor NOTRECOMMENDED
  24. This phrase, or the phrase "NOT RECOMMENDED" mean that
  25. there may exist valid reasons in particular circumstances when the
  26. particular behavior is acceptable or even useful, but the full
  27. implications should be understood and the case carefully weighed
  28. before implementing any behavior described with this label.
  29. \section MAY
  30. \anchor OPTIONAL
  31. This word, or the adjective "OPTIONAL", mean that an item is
  32. truly optional. One vendor may choose to include the item because a
  33. particular marketplace requires it or because the vendor feels that
  34. it enhances the product while another vendor may omit the same item.
  35. An implementation which does not include a particular option \ref MUST be
  36. prepared to interoperate with another implementation which does
  37. include the option, though perhaps with reduced functionality. In the
  38. same vein an implementation which does include a particular option
  39. \ref MUST be prepared to interoperate with another implementation which
  40. does not include the option (except, of course, for the feature the
  41. option provides.)
  42. */