Generator dokumentacji kodów źródłowych dla środowiska Matlab

• Autorzy: Nitoń B. , Poźniak K. , Romaniuk R. S.

Warianty tytułu

EN

Documentation generator for Matlab source codes

• Języki publikacji: PL

Abstrakty

PL

W artykule opisano zrealizowaną aplikację do dokumentowania kodów źródłowych Matlab. Zawarto w niej analizę dostępnych generatorów dokumentacji dla wymienionego języka programowania, ze szczególnym uwzględnieniem programów dostępnych bezpłatnie wraz z kodem źródłowym. Przedstawiono własne rozwiązanie oparte o dostępny na wolnej licencji program Doxygen oraz narzędzia wspomagające budowanie parserów Bison i Flex. Zaprezentowano wynik działania własnego generatora dokumentacji, na przykładowych kodach źródłowych.

EN

This paper contains a description of the application which purpose is to document the Matlab source codes. There is presented an analysis of documentation generators available for the mentioned programming language, with special taking into consideration the programs which are free and open source. After the analysis, there is described an idea which is based on the open source application called Doxygen as well as Bison and Flex tools designed to aid in the compiler development. In the end there is presented a result of functioning of own documentation generator on exemplary source codes.

Słowa kluczowe

PL

dokumentacja; kody źródłowe; MATLAB; Doxygen; UML

EN

documentation; source codes; MATLAB; Doxygen; UML

• Wydawca: Wydawnictwo SIGMA-NOT
• Czasopismo: Elektronika : konstrukcje, technologie, zastosowania
• Rocznik: 2011
• Tom: Vol. 52, nr 12
• Strony: 120--125
• Opis fizyczny: Bibliogr. 44 poz., il., rys.

Twórcy

autor

Nitoń B.

autor

Poźniak K.

autor

Romaniuk R. S.

• Politechnika Warszawska, Wydział Elektroniki i Technik Informacyjnych, Instytut Systemów Elektronicznych

Bibliografia

• [1] http://www.cppdoc.com/ - strona poświęcona narzędziu CppDoc.
• [2] http://classdoc.sourceforge.net/ - strona poświęcona narzędziu classdoc.
• [3] http://www.pragmaticworks.com/products/business-intelligence/bidocumenler/Overview.aspx - strona poświęcona narzędziu BI Documentor.
• [4] http://www.literateprogramming.com/autoduck.pdf - manual do programu Autoduck.
• [5] http://www.dbmanual.com/Features.aspx - strona poświęcona programowi DB Manual.
• [6] http://www.dbdesc!gom/ - strona poświęcona programowi dbdesc.
• [7] http://www.leadum.com/sql-documentator.sql - strona promocyjna programu DBScribe.
• [8] http://www.digitalmars.com/d/2.0/ddoc.html - specyfikacja języka D i wbudowanego w niego generatora dokumentacji.
• [9] http://code.msdn.microsoft.com/devscribe - strona poświęcona narzędziu devscribe.
• [10] http://www.doc-o-matic.com/editions_professional.html - strona poświęcona programowi Doc-O-Matic.
• [11] http://docpp.sourceforge.net/ - strona główna programu DOC++.
• [12] http://www.innovasys/products/dx2010/overview.aspx - strona promocyjna narzędzia Document! X.
• [13] http://epydoc. sourceforge.net/ - strona poświęcona programowi Epydoc.
• [14] http://www.freepascal.org/docs-html/fpdoc/fpdoc.html - strona poświęcona narzędziu fpdoc.
• [15] http://www.frasersoft.net/genhelp/ - strona poświęcona programowi GenHelp.
• [16] http://www.haskell.org/haddock/ - strona główna poświęcona narzędziu Haddock.
• [17] http://developer.apple.com/opensource/tools/headerdoc.html - strona poświęcona programowi HeaderDoc.
• [18] http://www.htmlhelpgenerator.net/html help generalor.htm - strona poświęcona programowi Help Generator.
• [19] http://projects.izzvsoft.de/trac/hypersql/wiki/HyperSQL - strona poświęcona narzędziu do dokumentacji HyperSQL.
• [20] http://www. Imagix.com/products/source-code-analysis.html - strona poświęcona narzędziu Imagix 4D.
• [21] http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html - strona poświęcona narzędziu Javadoc.
• [22] http://code.google.com/p/jgrousedoc/ - strona poświęcona narzędziu jGrouseDoc.
• [23] http://jsdoc.sourceforge.net/ - strona poświęcona narzędziu JSDoc.
• [24] http://code.google.com/p/jsdoc-toolkit/ - strona poświęcona narzędziu JsDoc Toolkit.
• [25] http://sirtaj.net/projects/kdoc/ - strona główna programu KDOC.
• [26] http://www.naturaldocs.org/languages.html - strona poświęcona programowi Natural Docs.
• [27] http://ndoc.sourceforge.net/ - strona główna poświęcona narzędziu NDoc.
• [28] http://www.phpdoc.org/ - strona poświęcona programowi phpDocumentor.
• [29] http://www.phpsimpledoc.org/ - strona poświęcona programowi phpSimpleDoc.
• [30] http://www.aivosto.com/project/project.hlml - strona poświęcona programowi Project Analizer.
• [31] http://rdoc.sourceforge.net/ - strona poświęcona programowi RDoc.
• [32] http://www.xs4all.nl/~rfsber/Robo/ - strona poświęcona programowi ROBODoc.
• [33] http://wwwptlogica.com/TwinText/ - strona poświęcona programowi TwinText.
• [34] http://www.omegacomputer.com/home_feature.htm - strona poświęcona programowi Universal Report.
• [35] http://vbdox.sourceforge.net/ - strona poświęcona programowi VBDOX.
• [36] http://wvw.helixoft.com/vsdocman/overview.html - strona poświęcona programowi VSdocman.
• [37] http://yardoc.org/more - strona poświęcona programowi YARD.
• [38] http://schwick.home.cern.ch/schwick/vhdldoc/ - strona poświęcona programowi VHDLDOC.
• [39] http://www.artefact.tk/software/matlab/m2html/ - strona poświęcona programowi M2HTML.
• [40] doxygen_manual-1.6.3.pdf - podręcznik do programu Doxygen.
• [41] http://www.sparxsystems.com.au/products/ea/index.html - strona poświęcona programowi Enterprise Architect.
• [42] htlp://www.mathworks.com/access/helpdesk/hejp/techdoc/learri_mallab/bqr_2pl.hlml - strona poświęcona nauce programowania w Matlabie.
• [43] http://www.gnu.org/software/bison/manual/bison.html - podręcznik do Bisona.
• [44] http://www.digipedia.pl/man/doc/view/flex.1/ - podręcznik do Flexa po polsku.