# ************************************************************* # # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # # ************************************************************* General Handling ---------------- - The developer inserts the OpenOffice.org version into the @since tag. - @since-Tag may contain any string which needs to end with a Version number. The first cipher following immediately on a white space is interpreted as start of the version number. - The @since Tag must stay completely within one line to allow tool support for retargeting. - To replace @since entries in the generated documentation, one needs to use the command line option -sincefile This option has to occur immediately after the -html option. If this option is not given, the original text of the @since tag is displayed. If the TransformationFile does not contain a specific entry, nothing is displayed for this entry. Format of the @since Tag Transformation File -------------------------------------------- Example ------- ***** BEGIN OF FILE ****** "1.1" "StarOffice 7.0" "2.0" "StarOffice 8.0" "2.1" "StarOffice 9.0" ***** END OF FILE ****** Rules and Restrictions ---------------------- * Each line contains two strings within "". The first string is the OpenOffice.org version number which is found in the @since tag. The second string is the string to display for this version. * No specific order among product versions is needed. * Empty lines and whitespaces are allowed, except: - Non empty lines must not start with white space. - Within OpenOffice.org version strings, no whitespace is allowed. * Whitespace within display strings is displayed as it is.