From d3ba5e5b26c5c7c60df2aa31704c90997aaac2ad Mon Sep 17 00:00:00 2001 From: Håkan Jonsson Date: Tue, 13 Sep 2016 10:44:32 +0200 Subject: doc: Initial doxygen framework for NSH SFC project MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A first attempt for a documentation generation using Doxygen for the NSH SFC project. Doxygen tagging and documentation in the code still need to be done. Based on a copy of the Doxygen framework in VPP. Top Makefile added to (only) build documentation. Change-Id: I795dfd921dc3db1bf9fe901fb352edf8a3d65b50 Signed-off-by: Håkan Jonsson --- doxygen/dir.dox.sample | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 doxygen/dir.dox.sample (limited to 'doxygen/dir.dox.sample') diff --git a/doxygen/dir.dox.sample b/doxygen/dir.dox.sample new file mode 100644 index 0000000..500fe59 --- /dev/null +++ b/doxygen/dir.dox.sample @@ -0,0 +1,29 @@ +/* + * Copyright (c) + * + * 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. +*/ +/*? %%clicmd:group_label CLI section description%% ?*/ -- cgit