SunnyQjm/NFD
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update doxygen configuration

Browse Source 
Most notably:
 - use relative paths in file list instead of file name only
 - enable sorting of brief descriptions of class members
 - show one enum value per line

refs #4163

Change-Id: Ib08601bc90f6eeb4e8754ed4335a447d5d0cc26c
This commit is contained in:
Davide Pesavento
2017-07-05 18:40:34 +00:00
committed by Junxiao Shi
parent 9ac95d3c1c
commit 84c65c0546
8 changed files with 347 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README-dev.md
+1 -1
View File
@@ -11,7 +11,7 @@ files:
Include the following license boilerplate into all `.hpp` and `.cpp` files:
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
/*
* Copyright (c) [Year(s)], [Copyright Holder(s)].
*
* This file is part of NFD (Named Data Networking Forwarding Daemon).
daemon/face/channel-log.hpp
+3 -2
View File
@@ -1,5 +1,5 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
/*
* Copyright (c) 2014-2017, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
@@ -37,9 +37,10 @@
* @{
*/
/** \internal */
/** \cond */
#define NFD_LOG_CHAN(level, msg) NFD_LOG_##level( \
"[" << this->getUri() << "] " << msg)
/** \endcond */
/** \brief Log a message at TRACE level */
#define NFD_LOG_CHAN_TRACE(msg) NFD_LOG_CHAN(TRACE, msg)
daemon/face/face-log.hpp
+3 -2
View File
@@ -1,5 +1,5 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
/*
* Copyright (c) 2014-2017, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
@@ -65,7 +65,7 @@ public:
* @{
*/
/** \internal */
/** \cond */
#define NFD_LOG_FACE(level, msg) NFD_LOG_##level( \
::nfd::face::FaceLogHelper< \
typename std::remove_cv< \
@@ -73,6 +73,7 @@ public:
>::type \
>(*this) \
<< msg)
/** \endcond */
/** \brief Log a message at TRACE level */
#define NFD_LOG_FACE_TRACE(msg) NFD_LOG_FACE(TRACE, msg)
daemon/fw/algorithm.hpp
+2 -2
View File
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2014-2016, Regents of the University of California,
/*
* Copyright (c) 2014-2017, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
daemon/table/cs-internal.hpp
+2 -2
View File
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2014-2016, Regents of the University of California,
/*
* Copyright (c) 2014-2017, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
daemon/table/cs.hpp
+2 -2
View File
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2014-2016, Regents of the University of California,
/*
* Copyright (c) 2014-2017, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
docs/doxygen.conf.in
+330 -158
View File
File diff suppressed because it is too large Load Diff
tests/core/version.t.cpp
+4 -4
View File
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2014-2016, Regents of the University of California,
* Copyright (c) 2014-2017, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
@@ -47,9 +47,9 @@ BOOST_AUTO_TEST_CASE(VersionString)
{
BOOST_TEST_MESSAGE("NFD_VERSION_STRING = " NFD_VERSION_STRING);
BOOST_STATIC_ASSERT(NFD_VERSION_MAJOR < 1000);
BOOST_STATIC_ASSERT(NFD_VERSION_MINOR < 1000);
BOOST_STATIC_ASSERT(NFD_VERSION_PATCH < 1000);
static_assert(NFD_VERSION_MAJOR < 1000, "");
static_assert(NFD_VERSION_MINOR < 1000, "");
static_assert(NFD_VERSION_PATCH < 1000, "");
char buf[12];
::snprintf(buf, sizeof(buf), "%d.%d.%d", NFD_VERSION_MAJOR, NFD_VERSION_MINOR, NFD_VERSION_PATCH);