CやJavaなどのプログラム ソース中のコメントから,モジュール仕様書を書き出すツール。プログラムと文書を同時に管理できる。 コメントは記述形式が固定されており、そのとおりに従うと関数やデータ型、オブジェクトに関する定型的な文書が生成される。htmlやrtf, TeXのほかにmicrosoftのhtmlヘルプファイルなどを生成できる。
・目次 1.目的 2.Doxygenのダウンロード 3.Doxygenでドキュメント作成 4.Doxygenの書き方 5.Doxygenでドキュメント作成ファイル確認 関連記事 1.目的 ・DoxygenはソースファイルからJavadocに則ったコメントを使用することにより、ドキュメントの作成が出来る。 ・Doxygenのインストールとドキュメント作成プロセスについて説明する。 マニュアル:Doxygen 2.Doxygenのダウンロード ・Doxygenのダウンロード →Doxygen 上記公式ホームページのダウンロードから、Doxygenのダウンロードが出来る。 (Doxy…
(狭い視点ですが)DoxygenでPythonを扱うのは無理です。 検討条件 windows10 python3.7 doxygen1.9.5(2022/11/03にインストール) 検討結果 対象のpythonコード import sys def tasu(aa,bb): c = aa + bb return c d = tasu(10,20) if d > 5: print("d",d) else: sys.exit() 結果 call graphとか、でましぇーん。 設定とか javaを選ぶのがいいというウワサに従い。。。 そもそも、Pythonが選べないのが、つらすぎる。。。。 コメント…
bool を返す constexpr function 互換性の関係で引数を省略できない 実装的には、引数は使用せず常に false を返す C++11 の constexpr function なので (void)param; を置いて回避する手は使えない Doxygen に怒られるので仮引数の型だけ残して仮引数をコメントアウトする手は使えない という条件でどうやって compiler, Doxygen, cppcheck の警告を完全回避できるんだ…と思ったんだが、 世の中には同じことを既に解決している人が既に居た。 stackoverflow.com constexpr bool isf…
Doxygenについては、以下の検索をたどってみてください。 Doxygen by Google Doxygen by Bing 本当にこのような高度なレベルのドキュメント生成機能を"GNU General Public Licence"で使わせて頂いていいのかと平身低頭になる強力な解析支援ツールであります。 既に多くの方が使い方、Tipsなどをアップされているので、今さら私がなにかをお伝えするよりも、検索した情報の方が有用ではないでしょうか。 ちなみにですが、Doxygenにお世話になる場合というのが、以下のシチュエーションが多いのが私の実情であります。 基本設計書、機能設計書までは、利用者…
昔、新卒で入社したときの最初の研修で真っ先に教えられたのが、「ビジネス文書の句読点にコンマピリオドを使うな!」ということでした。ビジネス文書では、句点にはマル「。」を、読点にはテン「、」を使います。今も研修で徹底されているかどうかはわかりませんが、中小企業ではなく、日本を代表する有名な大企業で教えられたことだったので、日本のビジネス文書のルールとしてはごく一般的なものだと思います。いや、日本語なのだからテンマルを使うのは当たり前だと思うでしょう? 義務教育課程の板書、ノート、作文、テストなどでは縦書き/横書きを問わず、当然テンマルを使っていましたよね? 実はその当たり前が通用しない分野もあるん…
Javadocのコメントについて ・目次 Javadocのコメントについて 1.目的 2.コメントの付け方 3.Doxygenでドキュメント作成確認(コメント) 関連記事 1.目的 ・Javadocで使用されるコメントの書き方について記載する。 ・コメントを記載した場合、Doxygenでどのように出力されるのか確認する。 参考:Doxygen(コメント) 2.コメントの付け方 C スタイルのコメント /** * ... コメント ... */ Qt スタイルのコメント /*! * ... コメント ... */ 追加のスラッシュ又は感嘆符で始まるコメント /// /// ... コ…
今日は prism の 1.0.0 への更新や Windows 環境での -C オプションの不具合修正などがありました。 [f93c27d86b] Alexander Momchilov 2024-08-26 13:19:22 UTC prism 利用時の shebang のオプションによる source encoding, default external encoding, default internal encoding の設定を対応しています。 [91c6c2bdb5] BurdetteLamar 2024-08-27 19:24:29 UTC Array#delete の rdoc…
楽に環境を導入できるVSCode+PlatformIOで、debugprobe(前はpicoprobeって名前だった気がする)を使ってRaspberry Pi Picoに書き込みたい。 Windows11でそのままやるとコケることに対する注釈的な記事なので、他環境のことは知らない(もしかするとこけないかも)。
Doxygenとは ・目次 1.目的 2.Doxygenとは(Doxygenの特徴) 3.Doxygenのメリット 4.まとめ 関連記事 1.目的 ・Doxygenについて知り、主に何が出来るのかを把握する。 ・DoxygenはJavadocスタイルのコメントを使用してソースファイルからドキュメントを生成できるツール。 ・Doxygenの特徴や出来ること、メリットについて記載する。 マニュアル:Doxygen 2.Doxygenとは(Doxygenの特徴) (1) ソースコードやコメントからドキュメントを自動生成するツール (2) 様々なドキュメントの作成が可能 ・ クラス図や関連図などの図表…
今日は object_id の採番の実装の小さな変更や bundler や prism の更新などがありました。 [690ea013ca] Matt Valentine-House 2024-07-17 10:00:26 UTC gc/default.c の不要な代入を削除しています。コミットログをみると不要な変数を削除したみたいになってますが実際には変数は残ってます。 [403f44ec2c] Peter Zhu 2024-07-16 19:38:48 UTC gc/default.c の OBJ_ID_INCREMENT というマクロの定義を RUBY_IMMEDIATE_MASK + 1…
※Jenkins®のロゴはJenkins Projectに帰属します。 あいさつ みなさまこんにちは、おさかなです。 現在所属しているチームでWindowsアプリを開発しているのですが、その中でJenkinsを使用してCI環境を構築する機会があったので、今回はCI/CDの紹介とその環境の構築について記事にまとめてみたいと思います。CI/CD構築に興味がある方、これから業務でCI/CDの導入を検討している方などの参考になれば幸いです。 あいさつ CI/CDとは? CI(継続的インテグレーション) CD(継続的デリバリー) CI/CDのフロー 主要なCI/CDサービス JenkinsでのCI/CD…
JTAGデバッガをwslのUSBへ認識させる usbipdの環境を整えます。 wsl側に認識させる OpenOCDの実行 debugの実行 実機のJTAGを動作させるのにはまった点 参考にしたサイト 前回記事でverilator simでJTAGデバッグするという話を書きましたが、今回は実機デバッグのお話です。
VexRiscvの生成環境の構築 VexRiscvコアの作成 SoCの作成 Verilatorによるsimulation SIM TOP階層(C++階層)の作成 class BrieyWorkspace RAMデータ(命令コード)の読み込み makefileの代わりにsim実行スクリプトを作成します JTAGデバッグ OpenOCDの準備 OpenOCDの実行 GDBの実行 VS codeからGDBの実行 参考にしたサイト VexRiscvにはOpenOCDを用いて、RTL simulationでJTAGデバッグが比較的簡単に行う仕組みが用意されています。 その利用方法をここにとどめておきます…
しました。 かなり大幅な変更を導入し、パーサ関係もtoml::valueもほぼ全部書き換えたのですが、シンプルな使い方をしている場合は多分ほとんど変更なしでコンパイルが通ると思います。 ちょっと進んだ機能を使っていた場合は、色々と変更につき合わせるかと思いますが、その分新機能も多くあるので、お付き合いいただけると幸いです。 そもそもtoml11とは C++でTOMLファイルを扱うためのライブラリです。 その名の通りC++11以降をサポートしており、11, 14, 17, 20でテストしています。 もとはヘッダオンリーライブラリですが、コンパイル時間が長かったため、v4からはビルドする選択肢を追…
2024/06/10 とりあえずできた、メモは時系列もぐちゃぐちゃなので何とかしたいが、とりあえず手順を整理して記述しなおそう。 手順を整理、必要なパッケージはOS書き込みからを再度実行して確認予定。 前準備 OSインストール直後はディスク容量に空きが少ない場合、gpartedをインストールして、パーテション拡張しておく。 sudo apt install gparted swapファイル確認。 swapon --show 100MBなので、拡大 swap停止sudo dphys-swapfile swapoff設定ファイル変更sudo nano /etc/dphys-swapfile例CON…
ICQ サービス終了 今も「エッオ〜」の呼び声が空耳で聞こえてくる ICQ が久しぶりにネットニュースになったと思ったら、サービス終了のお知らせでした。いつの間にかロシア VK の傘下になっていたようです。最近は「ウッラ〜」とか「ニチェボ〜」とか言っていたのでしょうか。 ロシアでは I Seek You ではなく They Seek Us とか。 www.itmedia.co.jp AI 様、新熟語を御下賜くださる これは幻覚 (Hallucination) というより、AI 様が概念をより適切な熟語で表し給はれたものと思いたい。 幕末明治期に漢語を元に西洋文明の概念を熟語化したように、AI …
wolfSSL社のドキュメントは以下のGitリポジトリで管理されています. github.com ただ,日本語でビルドしようとすると一癖ある状況です.いずれプルリクを送ろうと思っていますが,ひとまず暫定的なビルド方法を示します. なお,基本的に最新版の日本語/英語ドキュメントは以下のWebページからhtml/pdfともに見ることができます. ドキュメント | wolfSSL 組み込みSSL/TLSライブラリ よって,基本的には自分でビルドする必要はありません. 依存するパッケージのインストール Ubuntu / Debian sudo apt updatesudo apt -y install…
Linuxカーネルドキュメント (公式) Linuxカーネルの公式のドキュメントである。 Quick searchで検索するか、Contentsから項目を探す。例えば、CANインターフェースについては、 Subsystems → Network Interfaces → Networking → SocketCAN - Controller Area Network に書かれている。過去のLinuxカーネルのバージョンについては下記から。 https://www.kernel.org/doc/html/その他のドキュメントについては下記から。 https://www.kernel.org/do…