X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=doxygen%2Fdir.dox.sample;h=ccdd095abb2d68a7e4fa7795a9909060d5451f4a;hb=61717cc38;hp=8dc0fee7749c8b9e0684ad45d9ca2ca46bc2a056;hpb=b585097048884e063ac25aecc26a6802ee3faa4d;p=vpp.git diff --git a/doxygen/dir.dox.sample b/doxygen/dir.dox.sample index 8dc0fee7749..ccdd095abb2 100644 --- a/doxygen/dir.dox.sample +++ b/doxygen/dir.dox.sample @@ -1,6 +1,30 @@ +/* + * 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 +@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%% ?*/ +/*? %%syscfg:group_label Startup config section description%% ?*/