Versions Compared

Old Version 11

changes.mady.by.user Marcel Offermans

Saved on

compared with

New Version 12

changes.mady.by.user Richard S. Hall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

All source files must begin with the comments shown in the following code sample.

Code Block
/*
 * Licensed to Copyrightthe 2006 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  Licensedfile
 * 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
 * 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
 *   limitations under the License.
 *
 */

Note that this comment part is not according to the JavaDoc style (See: How to write doc comments for JavaDoc - Sun Microsystems, Inc.) as this is file specific information that is not relevant in generated API documentation.

...

Code Block
/**
 * This class is not really a class, because this file is just
 * a template that shows how the file header and class header
 * should look like.
 *
 * @author <a href="mailto:felix-dev@incubatordev@felix.apache.org">Felix Project Team</a>
 */

...