#?file:?matdoc.py
#?author:?Andrea?Vedaldi
#?brief:?Extact?comments?from?a?MATLAB?mfile?and?generate?a?Markdown?file

import?sys?os?re?shutil
import?subprocess?signal
import?string?fnmatch

from?matdocparser?import?*
from?optparse?import?OptionParser

usage?=?“““usage:?%prog?[options]?

Extracts?the?comments?from?the?specified??and?prints?a?Markdown
version?of?them.“““

optparser?=?OptionParser（usage=usage）
optparser.add_option（
????“-v“?“--verbose“
????dest????=?“verb“
????default?=?False
????action??=?“store_true“
????help????=?“print?debug?information“）

findFunction?=?re.compile（r“^\s*（function|classdef）.*$“?re.MULTILINE）
getFunction?=?re.compile（r“\s*%\s*（\w+）\s*（.*）\n“
??????????????????????????“（（\s*%.*\n）+）“）
cleanComments?=?re.compile（“^\s*%“?re.MULTILINE）

#?--------------------------------------------------------------------
def?readText（path）:
#?--------------------------------------------------------------------
????with?open?（path?“r“）?as?myfile:
????????text=myfile.read（）
????return?text

#?--------------------------------------------------------------------
class?MatlabFunction:
#?--------------------------------------------------------------------
????def?__init__（self?name?nature?brief?body）:
????????self.name?=?name
????????self.nature?=?nature
????????self.brief?=?brief
????????self.body?=?body

????def?__str__（self）:
????????return?“%s?（%s）“?%?（self.name?self.nature）

#?--------------------------------------------------------------------
def?findNextFunction（test?pos）:
#?--------------------------------------------------------------------
????if?pos?==?0?and?test[0]?==?‘%‘:
????????#?This?is?an?M-file?with?a?MEX?implementation
????????return?（pos?‘function‘）
????m?=?findFunction.search（test?pos）
????if?m:
????????return?（m.end（）+1?m.group（1））
????else:
????????return?（None?None）

#?--------------------------------------------------------------------
def?getFunctionDoc（text?nature?pos）:
#?--------------------------------------------------------------------
????m?=?getFunction.match（text?pos）
????if?m:
????????name?=?m.group（1）
????????brief?=?m.group（2）.strip（）
????????body?=?clean（m.group（3））
????????return?（MatlabFunction（name?nature?brief?body）?m.end（）+1）
????else:
????????return?（None?pos）

#?--------------------------------------------------------------------
def?clean（text）:
#?--------------------------------------------------------------------
????return?cleanComments.sub（““?text）

#?--------------------------------------------------------------------
def?extract（text）:
#?--------------------------------------------------------------------
????funcs?=?[]
????pos?=?0
????while?True:
????????（pos?nature）?=?findNextFunction（text?pos）
????????if?nature?is?None:?break
????????（f?pos）?=?getFunctionDoc（text?nature?pos）
????????if?f:
????????????funcs.append（f）
????return?funcs

#?--------------------------------------------------------------------
class?frame（object）:
#?------

?屬性????????????大小?????日期????時間???名稱
-----------?---------??----------?-----??----

?????文件????????119??2016-05-03?03:05??matconvnet\.gitattributes

?????文件????????877??2016-05-03?03:05??matconvnet\.gitignore

?????文件??????????0??2016-05-03?03:05??matconvnet\.gitmodules

?????文件???????1562??2016-05-03?03:05??matconvnet\CONTRIBUTING.md

?????文件????????735??2016-05-03?03:05??matconvnet\COPYING

?????文件??????28930??2016-05-03?03:05??matconvnet\doc\blocks.tex

?????文件??????18884??2016-05-03?03:05??matconvnet\doc\figures\imnet.pdf

?????文件?????702358??2016-05-03?03:05??matconvnet\doc\figures\pepper.pdf

?????文件??????68592??2016-05-03?03:05??matconvnet\doc\figures\svg\conv.svg

?????文件??????65347??2016-05-03?03:05??matconvnet\doc\figures\svg\convt.svg

?????文件???????6561??2016-05-03?03:05??matconvnet\doc\figures\svg\matconvnet-blue.svg

?????文件???????6734??2016-05-03?03:05??matconvnet\doc\figures\svg\matconvnet-white.svg

?????文件??????33879??2016-05-03?03:05??matconvnet\doc\fundamentals.tex

?????文件??????16542??2016-05-03?03:05??matconvnet\doc\geometry.tex

?????文件??????20089??2016-05-03?03:05??matconvnet\doc\impl.tex

?????文件??????18876??2016-05-03?03:05??matconvnet\doc\intro.tex

?????文件???????3891??2016-05-03?03:05??matconvnet\doc\Makefile

?????文件???????4070??2016-05-03?03:05??matconvnet\doc\matconvnet-manual.tex

?????文件???????7046??2016-05-03?03:05??matconvnet\doc\matdoc.py

?????文件??????11108??2016-05-03?03:05??matconvnet\doc\matdocparser.py

?????文件???????2729??2016-05-03?03:05??matconvnet\doc\references.bib

?????文件???????8605??2016-05-03?03:05??matconvnet\doc\site\docs\about.md

?????文件???????2957??2016-05-03?03:05??matconvnet\doc\site\docs\css\fixes.css

?????文件???????3393??2016-05-03?03:05??matconvnet\doc\site\docs\developers.md

?????文件???????2147??2016-05-03?03:05??matconvnet\doc\site\docs\faq.md

?????文件??????59846??2016-05-03?03:05??matconvnet\doc\site\docs\figures\stn-perf.png

?????文件??????32055??2016-05-03?03:05??matconvnet\doc\site\docs\figures\stn-samples.png

?????文件???????2940??2016-05-03?03:05??matconvnet\doc\site\docs\functions.md

?????文件???????1148??2016-05-03?03:05??matconvnet\doc\site\docs\gpu.md

?????文件???????5061??2016-05-03?03:05??matconvnet\doc\site\docs\index.md

............此處省略399個文件信息