简介

Doxygen是一个能从带注释的源码中自动生成说明文档的标准工具，它支持众多流行的编程语言，包括C/C++、C#, PHP, Java, Python, IDL 等

Doxygen能够从以下三个方面进行工作：

• 从一组源文件中生成HTML格式的在线文档和LETEX格式的离线文档，此外还提供了RTF（MS-Word）、PostScript、超链接 PDF、压缩 HTML 和 Unix等格式输出。

• 从源码中提取代码结构，通过依赖关系图、继承图和协作图自动生成各种元素之间的关系图。

• 为用户制作用户手册和网站

  Doxygen可以在Mac OS、Linux和Windows下工作，还可以在大多数其他Unix上运行。

安装

Ubuntu下可以直接从apt源进行安装

sudo apt-get install graphviz
sudo apt-get install doxygen
# 带gui的doxygen
sudo apt-get install doxygen-gui

使用

你可以使用特定的命令行来生成配置文件手动配置，也可以执行doxywizard在图形化界面中进行配置。在doxygen中，不同工具之间的关系图如下所示

从命令行生成

1. 创建配置文件

doxygen -g <config-file>
# 或（不含注释）
doxygen -s -g <config-file>

<config-file>为生成配置文件的名称，如果不输入则默认为Doxyfile，若已存在名为 <config-file>的文件，则会将原先的 <config-file>重命名为 <config-file>.bak。

2. 修改配置文件

这里列举出常用的配置选项，关于完整的配置选项说明，可以参考doxygen官网提供的Config-Docs

项目相关配置

• DOXYFILE_ENCODING

  指定用于配置文件中所有字符的编码，默认为UTF-8。

• PROJECT_NAME

  项目名称，默认为 My Project

• OUTPUT_DIRECTORY

  标记用于指定将生成的文档写入的（相对或绝对）路径。如果输入了相对路径，则该路径将相对于 doxygen 的启动位置。如果留空，将使用当前目录。

• OUTPUT_LANGUAGE

  标记用于指定编写 doxygen 生成的所有文档的语言。

构建相关配置

• EXTRACT_ALL

  如果设置为 YES，则 doxygen 将假定文档中的所有实体都已记录，即使没有可用的文档也是如此。私有类成员和静态文件成员将被隐藏，除非EXTRACT_PRIVATE分别EXTRACT_STATIC标记设置为 YES.

• EXTRACT_PRIVATE

  如果设置为 YES，则类的所有私有成员都将包含在文档中。

• EXTRACT_STATIC

  如果设置为 YES，则文件的所有静态成员都将包含在文档中。

• EXTRACT_LOCAL_CLASSES

  如果设置为 YES，则在源文件中本地定义的类（和结构）将包含在文档中。如果设置为 NO，则仅包括头文件中定义的类。

与输入文件相关配置

• INPUT

  标记用于指定包含记录的源文件的文件和/或目录。

• INPUT_ENCODING

  标记可用于指定 doxygen 解析的源文件的字符编码。

• RECURSIVE

  指定是否也应搜索子目录以查找输入文件。

绘图相关配置

• HAVE_DOT

  是否使用Graphviz图形可视化工具包

• CALL_GRAPH

  为每个全局函数或类方法生成一个调用依赖图，启用此选项将显着增加运行时间。

• CALLER_GRAPH

  为每个全局函数或类方法生成调用者依赖图，启用此选项将显着增加运行时间。

3. 运行doxygen

doxygen <config-file>

根据您的设置，doxygen 将在输出目录中创建 html、rtf、latex、xml、man 和/或 docbook 目录。

从gui生成

终端键入doxywizard，打开图形化界面

doxywizard

配置相关选项，具体可以参考上一部分的选项说明

生成配置文档

查看文档

在html文档中找到index.html，打开即可查看你的专属在线文档！

后续

 喜欢的话可以关注一下我的公众号技术开发小圈，尤其是对深度学习以及计算机视觉有兴趣的朋友，我会把相关的源码以及更多资料发在上面，希望可以帮助到新入门的大家！

前言：笔者自己是一位穷逼的个人开发者。自己开发了一款应用，但上架各大手机应用商店基本上都是需要有软件著作权的。现分享一下我申请的全过程，当然网上申请流程已经烂大街都是了，主要分享的是申请资料

	申请软件著作权的3种方法

1. 自己网上申请，把所需材料递交给国家版权中心（北京的主中心，和3个分局），其余3个城市分局只是代理收资料而已，他们也是邮寄到北京国家版权中心处理的。（该方法办理不需要任何费用）
2. 自己网上申请，把所需材料邮寄到北京国家版权中心（费用是你寄到北京的快递费，北京国家版权中心邮寄回来的快递费需不需要你出这个我就不清楚了）。
3. 通过代理公司办理，但是你经常可以看到说加急多少多少钱，其实版权中心也是有提供这种服务的，不过是额外付费的

下图是本人自己去深圳国家版权中心拍的，自己办理免费的啊，31-35那个算加急的，不过自己不加急办理也是差不多35个工作日

笔者在深圳这边，过去深圳的分部不远，所以选择了第一种。至于第二种邮寄未曾尝试过，请自行百度吧。至于第三种的话，有钱的可以考虑（笔者穷逼一个），办理一张软著大概至少需要300+以上（这个价格是淘宝那种才比较便宜，正规点的约600元起，但是建议别去淘宝，你以后要处理其他事务会比较麻烦），而且软件的使用说明和源代码你不提供的话，还得叫人撰写至少也要100+。还有人家代理公司办理的速度也是和你自己办理的速度一样的。

	教程开始

http://www.ccopyright.com.cn/ 这个地方注册一下账号
首页的 我要登记 —> 软件登记

进入个人中心后，在左侧下方的在线业务中选择“我要登记”，然后再选择“R11.计算机软件著作权登记申请”

填写资料可以看看我的



至于网上填写申请最后一项，按照默认的就可以了，一般交存—>一种文档…例外交存那里不用理会


上面只需要填写4处，其他的不用理会

当然我讲的不是很详细，要详细的可以考虑去看这篇文章https://blog.csdn.net/cmqwan/article/details/82856206
当然说说资料，先看看我去版权大厅拍的，当然你看一下参考一下就行了，具体的看下来

上面别太当真，不然你会很乱，你只需要准备下面材料就行了，或者拿我的资料去改改

1. 身份证复印件
2. 说明书一份16+张(我自己写了24张，这玩意你看我附件就知道了，很容易的)
3. 软件著作权申请表一份4张（就是你刚才在网上填写的申请表，打印出来就行了，好像第四张要签名。注意这里有一个坑，看下面）
4. 源程序一份61张（这种直接那我的资料，然后把第一页的软件名称改掉，和每一页的页头的软件名称改掉就可以了）

4张申请表的注意事项
每一页的页头最上面必须是流水号（条纹码），因为他的打印真的很怪，打印出来出现下面这张的错误情况

上面是错误的，下面才是正确的，4张每一张的流水号都在最上面（每一张的最上面只能是流水号，不能出现上一页的内容），而且底下不能出现下一页的内容

我申请的流程状态

12月30号那天办理的，然后到现在2月24号拿到手，一共两个月24天，而且快递也慢（应该也是疫情影响的），不然更快。整体还算满意吧，毕竟新年，元宵，还有疫情影响都不知道他们休了多少天。
给你们大概看一些源代码资料和软件说明资料的截图

软件使用说明的大致截图

源代码截图

例外，文件原本是我取用https://blog.csdn.net/cmqwan/article/details/82856206该链接里面的提供素材进行修改的，也感谢原作者 cmqwan

文档下载地【免费】https://download.csdn.net/download/qq_23064433/12188550
链接：https://pan.baidu.com/s/1oR7FhSJtME1xhrYKrAEGaA
提取码：y70o

本人邮箱，真有需要的可以发来问问，但别骚扰我 2309680188@qq.com

上图是我传递之后的所有状态，你们可以参考一下，2月13号过后不久我就收到快递了

2020/07/03 更新说明
如果有公司建议使用软著著作权人为公司的，要不然在以后上架到应用商店时，如果你的应用商店认证是你的公司，但是软著著作权人又是个人的话，有些应用商店还有要求你写一个公司和著作权人的授权说明书，至于公司的怎么申请，可以去翻翻下面的评论
2020/10/16 更新说明
去分局的话是需要预约的，在微信公众号里面预约，《中国版权服务》底部导航->微平台->后续操作我就记不清了。

另外说明，该文章很有可能会被其他网站转载，导致你找不到评论，原贴在csdn（根据标题搜索）

第一节 总流程
一、（原理介绍）
XXXXXXXXXXXXXXXXXX
二、（总的流程图）

第二节：主接口1
一、（原理介绍）
XXXXXXXXXXXXXXXXXXXXXXXXX
二、（总的流程图）

例子：
流程图

步骤描述：步骤描述需要一定的逻辑性。但不一定是纯文字形式，可以用公式，便于理解的伪代码+文字等方式进行步骤描述

三、分模块介绍
1、逻辑模块一：
1.1 代码
1.2 流程图
1.3 详细说明

例子：
1、 三个框相交，则去掉中间的

1.  if(detectResult.size() > 1)  
2.      for(int i=1;i<detectResult.size()-1;i++){  
3.          if (((detectResult[i].x + detectResult[i].width + 2) >= detectResult[i + 1].x) &&  
4.              (detectResult[i].x <= (detectResult[i - 1].x + detectResult[i - 1].width - 2))){  
5.          }  
6.          if (((detectResult[i].x + detectResult[i].width + 2) >= detectResult[i + 1].x) &&  
7.              (detectResult[i].x <= (detectResult[i - 1].x + detectResult[i - 1].width - 2))  
8.              && ((detectResult[i + 1].x - detectResult[i - 1].x - detectResult[i - 1].width) < (0.7*(ROIWIDTH + avg_distance_of_chars)))){  
9.              detectResult.erase(detectResult.begin() + i);  
10.             i--;  
11.         }                     
12.     }

2、接口模块：
2.1 代码
2.2 功能描述
2.3 接口描述
2.4 核心原理

例子1：
以cifar-10为例说明，具体的运算过程，对应代码：

1、卷积：
1.

inline void Conv(const int *restrict pSrc, int *restrict pDst, const int *restrict pKer, const int input_w, const int input_h, int k_size, int stride)  
2.  {  
3.      int   y, i, j, k;  
4.      int tSum;  
5.      const int *pSS = pSrc;  
6.    
7.    
8.      for (y = 0; y< (input_h + stride - 1) - k_size + 1; y += stride, pSS += (stride*input_w))  
9.      {  
10.         for (i = 0; i<(input_w + stride - 1) - k_size + 1; i += stride)  
11.         {  
12.             tSum = 0;  
13.             for (j = 0; j<k_size; j++)  
14.             {  
15.                 for (k = 0; k<k_size; k++)  
16.                 {  
17.                     tSum += pSS[j * input_w + i + k] * pKer[j * k_size + k];                      
18.                 }  
19.             }  
20.   
21.             *pDst++ = tSum;   
22.         }  
23.     }  
24. }  

1.1 功能描述
宽为input_w、高为input_h的输入图像pSrc，与k_size x k_size的卷积核pKer进行卷积，得到宽为input_w、高为input_h特征图pDst。

1.2 接口描述

名称  In/out/Par  Size/precision  Description/value
pSrc    in  input_w* input_h    输入图像
pDst    out input_w* input_h    输出图像
pKer    in  k_size * k_size 卷积核
input_w parameter   int 输入图像宽
input_h parameter   int 输入图像高
k_size  parameter   int 卷积核宽，一般为奇数
stride  parameter   int 卷积核在图像上上下左右滑动的平移像素幅度

1.3 核心原理（以cifar-10为例进行说明）：
（1）输入是3个32*32, 共3*1024=3072。每条边padding为2，则内存里实际为3个36*36.
（2）卷积核个数是3维的5*5分别与3个输入进行卷积运算,得到3维的32*32的输出,这里将3维的32*32对应位相加得到一张32*32的feature Map
（3）输出：如果有64个3维的5*5卷积核就有64张feature Map
具体过程图示为：

卷积的权值读取方式为:
（1）第1个5*5作用于第一张输入全图，
（2）第2个5*5作用于第二张输入全图，
（3）第3个5*5作用于第三张输入全图，
（4）再把这三个对应位置相加,在加上biases,得到第一张feature map
（5）最后64个5*5*3重复上面的过程，得到64个featuremap
（6）这里weights有3*5*5*64个,biases有64个.
这里输入是3 个图像，输出是64个特征图，卷积核是5*5权值个数是64* 5*5*3

例子2：