diff options
| author | Marius Vollmer <marius.vollmer@nokia.com> | 2010-01-21 11:12:07 +0200 |
|---|---|---|
| committer | Marius Vollmer <marius.vollmer@nokia.com> | 2010-01-21 11:12:07 +0200 |
| commit | d486813727908977c976336f51222a7cf74dde61 (patch) | |
| tree | 4507ccc9428ed14f092f6490a92b5127881e5293 | |
| parent | ae656f5a271ecf81a6e159d1fbd3c22dc6e2bdeb (diff) | |
Document <deprecated/> flag.
| -rw-r--r-- | doc/context-providers.txt | 26 |
1 files changed, 22 insertions, 4 deletions
diff --git a/doc/context-providers.txt b/doc/context-providers.txt index ebb32af2..956dc722 100644 --- a/doc/context-providers.txt +++ b/doc/context-providers.txt @@ -86,10 +86,6 @@ without any additional markup. Types ~~~~~ -*NOTE:* This is preview of things that might come, or not. For now, -just use a +type+ attribute in your +key+ elements with one of -+"TRUTH"+, +"STRING"+, +"INT"+, or +"DOUBLE"+ as the value. - ContextKit uses the experimental link:context-types.html[Desktop Type System]. A property declaration should have a +type+ element that conforms to the Desktop Type System. @@ -113,6 +109,28 @@ this: </key> ------------------ +Deprecating properties +~~~~~~~~~~~~~~~~~~~~~~ + +You can add a +deprecated+ element to your property declaration to +mark it as deprecated. Run-time warnings will be emitted when +applications connect to a deprecated property, and documentation that +is generated from your property declarations will mark them as +deprecated. + +Example: + +[xml] +------------------ +<key name="SoundedLikeAGoodIdea" + type="string"> + <deprecated/> + <doc> + Don't use this property, use ABetterIdeaByFar instead. + </doc> +</key> +------------------ + Guidelines for property providers --------------------------------- |