1# ************************************************************* 2# 3# Licensed to the Apache Software Foundation (ASF) under one 4# or more contributor license agreements. See the NOTICE file 5# distributed with this work for additional information 6# regarding copyright ownership. The ASF licenses this file 7# to you under the Apache License, Version 2.0 (the 8# "License"); you may not use this file except in compliance 9# with the License. You may obtain a copy of the License at 10# 11# http://www.apache.org/licenses/LICENSE-2.0 12# 13# Unless required by applicable law or agreed to in writing, 14# software distributed under the License is distributed on an 15# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16# KIND, either express or implied. See the License for the 17# specific language governing permissions and limitations 18# under the License. 19# 20# ************************************************************* 21 22 23 General Handling 24 ---------------- 25 26- The developer inserts the OpenOffice.org version into the @since tag. 27 28- @since-Tag may contain any string which needs to end with a Version number. 29 The first cipher following immediately on a white space is interpreted as start of the version number. 30 31- The @since Tag must stay completely within one line to allow tool support for retargeting. 32 33- To replace @since entries in the generated documentation, one needs to use 34 the command line option 35 36 -sincefile <TransformationFile-path> 37 38 This option has to occur immediately after the -html option. 39 If this option is not given, the original text of the @since tag is 40 displayed. 41 42 If the TransformationFile does not contain a specific entry, 43 nothing is displayed for this entry. 44 45 46 47 Format of the @since Tag Transformation File 48 -------------------------------------------- 49 50Example 51------- 52 53***** BEGIN OF FILE ****** 54"1.1" "StarOffice 7.0" 55"2.0" "StarOffice 8.0" 56"2.1" "StarOffice 9.0" 57***** END OF FILE ****** 58 59 60 61Rules and Restrictions 62---------------------- 63 64* Each line contains two strings within "". 65 The first string is the OpenOffice.org version number which is found in the @since tag. 66 The second string is the string to display for this version. 67* No specific order among product versions is needed. 68* Empty lines and whitespaces are allowed, except: 69 - Non empty lines must not start with white space. 70 - Within OpenOffice.org version strings, no whitespace is allowed. 71* Whitespace within display strings is displayed as it is. 72