diff options
Diffstat (limited to 'doxygen')
| -rw-r--r-- | doxygen/dir.dox.sample | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doxygen/dir.dox.sample b/doxygen/dir.dox.sample index 8dc0fee7749..41e84d7bee4 100644 --- a/doxygen/dir.dox.sample +++ b/doxygen/dir.dox.sample @@ -1,6 +1,28 @@ +/* + * Copyright (c) <YEAR> <YOUR AFFILIATION HERE> + * + * Licensed 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. + */ + /* Doxygen directory documentation */ + /** @dir @brief Someone please fix this description @todo This directory needs a description. + +This is where you would document the contents of a directory. + +This looks like a C file but it is not part of the build; it is purely +for documentation. */ |