Changeset 2512 in josm for trunk/src/org/openstreetmap/josm/gui/help/HelpUtil.java
- Timestamp:
- 2009-11-24T10:45:04+01:00 (14 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/org/openstreetmap/josm/gui/help/HelpUtil.java
r2389 r2512 19 19 /** 20 20 * Replies the base wiki URL. 21 * 21 * 22 22 * @return the base wiki URL 23 23 */ … … 28 28 /** 29 29 * Replies the base wiki URL for help pages 30 * 30 * 31 31 * @return the base wiki URL for help pages 32 32 */ … … 37 37 /** 38 38 * Replies the URL on the wiki for an absolute help topic. The URL is encoded in UTF-8. 39 * 39 * 40 40 * @param absoluteHelpTopic the absolute help topic 41 41 * @return the url … … 53 53 /** 54 54 * Replies the URL to the edit page for the absolute help topic. 55 * 55 * 56 56 * @param absoluteHelpTopic the absolute help topic 57 57 * @return the URL to the edit page … … 66 66 * Extracts the relative help topic from an URL. Replies null, if 67 67 * no relative help topic is found. 68 * 68 * 69 69 * @param url the url 70 70 * @return the relative help topic in the URL, i.e. "/Action/New" … … 82 82 * Extracts the absolute help topic from an URL. Replies null, if 83 83 * no absolute help topic is found. 84 * 84 * 85 85 * @param url the url 86 86 * @return the absolute help topic in the URL, i.e. "/De:Help/Action/New" … … 106 106 * <li>/De:Help if the current locale is a locale with language "de"</li> 107 107 * </ul> 108 * 108 * 109 109 * @return the help topic prefix 110 110 * @see #getHelpTopicPrefix(Locale) … … 120 120 * <li>/De:Help if the locale is a locale with language "de"</li> 121 121 * </ul> 122 * 122 * 123 123 * @param locale the locale. {@see Locale#ENGLISH} assumed, if null. 124 124 * @return the help topic prefix … … 137 137 /** 138 138 * Replies the absolute, localized help topic for the given topic. 139 * 139 * 140 140 * Example: for a topic "/Dialog/RelationEditor" and the locale "de", this method 141 141 * replies "/De:Help/Dialog/RelationEditor" 142 * 142 * 143 143 * @param topic the relative help topic. Home help topic assumed, if null. 144 144 * @param locale the locale. {@see Locale#ENGLISH} assumed, if null. … … 164 164 * Replies the absolute, localized help topic for the given topic and the 165 165 * current locale. 166 * 166 * 167 167 * @param topic the relative help topic. Home help topic assumed, if null. 168 168 * @return the absolute, localized help topic … … 176 176 /** 177 177 * Replies the context specific help topic configured for <code>context</code>. 178 * 178 * 179 179 * @return the help topic. null, if no context specific help topic is found 180 180 */ … … 208 208 * Replies the global help action, if available. Otherwise, creates an instance 209 209 * of {@see HelpAction}. 210 * 210 * 211 211 * @return 212 212 */ … … 221 221 /** 222 222 * Makes a component aware of context sensitive help. 223 * 223 * 224 224 * A relative help topic doesn't start with /Help and doesn't include a locale 225 225 * code. Example: /Dialog/RelationEditor is a relative help topic, /De:Help/Dialog/RelationEditor 226 226 * is not. 227 * 227 * 228 228 * @param component the component the component 229 229 * @param topic the help topic. Set to the default help topic if null. … … 241 241 * This is a simple marker method for help topic literals. If you declare a help 242 242 * topic literal in the source you should enclose it in ht(...). 243 * 243 * 244 244 * <strong>Example</strong> 245 245 * <pre> … … 248 248 * putValue("help", ht("/Dialog/RelationEditor")); 249 249 * </pre> 250 * 251 * 250 * 251 * 252 252 * @param helpTopic 253 253 */
Note:
See TracChangeset
for help on using the changeset viewer.