Doxygen을 좀 더 편리하게 사용하고 싶다 [미달]

소개

요 전날 Doxygen에 대한 기사를 썼습니다.
Doxygen을 사용하여 문서 만들기

실제로 Doxygen을 사용하고 있어, 좀 더 편리하게 사용하고 싶다, 여기는 주의하지 않으면 안 된다, 등 생각한 곳을 남기기 위한 기사입니다.

마지막은 과제를 남기고 끝났습니다.

참고 사이트

PlantUML을 명령에서 조작하는 매뉴얼

plantuml 공식 사이트입니다

Writing documentation for OpenCV

OpenCV doxygen 문서를 작성하기위한 안내서

준비

doxygen은 설치되어 있다고 가정합니다.
또, graphviz를 사용하므로, 그것도 별도 인스톨하고 있다.

디렉토리

작업 디렉토리를 준비합니다.
기본적으로 마지막 기사와 같습니다.

Graphviz와 plantuml.jar

plantuml.jar 는 C:\PlantUML 에 넣어 둡니다.
( plantuml.jar 에 대해서는 이전 기사를 참조)
graphviz 경로가 통과했는지 확인하십시오.

> java -jar C:\PlantUML\plantuml.jar -testdot
Dot version: dot - graphviz version 2.38.0 (20140413.2041)
Installation seems OK. File generation OK

PlantUML을 PNG 이미지로 취급

pu 폴더를 만들고 그 안에 .pu를 집계한다.pu 파일에 작성된 UML에서 PNG 이미지 파일을 생성하는 명령.
java -jar C:/PlantUML/plantuml.jar <puファイル>
↑를 치면 pu 파일과 같은 계층에 startuml의 수만큼 PNG 파일이 생성된다.

이것을 일일이 치는 것이 귀찮아서, VS Code의 태스크로 한다

{
    "version": "2.0.0",
    "tasks": [
        {
            # --- doxygen Doxyfileコマンドについて書かれている箇所
            # --- 前回の記事を参照のこと
        },
        {
            "label": "plantuml",
            "type": "shell",
            "command": ["java -jar C:/PlantUML/plantuml.jar ./pu -o ../images/pupng"],
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "presentation": {
                "reveal": "always",
                "clear": true,
                "panel": "shared"
            },
            "options": {
                "cwd": "${workspaceRoot}/workspace/src"
            }
        }
    ]
}

출력 대상 폴더는 -o 옵션으로 지정

주의! 출력 대상 경로 정보

PlantUML 공식적으로 써 있습니다만, 이하와 같다.

상대 경로로 지정하면 이미지 파일이 입력 파일의 상대 경로 디렉토리에 출력됩니다.

java -jar C:\PlantUML\plantuml.jar .\workspace\src\puml\-o ..\images\pupng

PNG 이미지로 만든 것을 사용

PNG 이미지로 버리면, 나머지는 링크를 붙이는 문법에 「!」를 붙여 이미지로서 묻는 것뿐입니다

마크다운에 직접 UML을 쓰면 길어져 버리므로, 일단 화상으로 해 묻으면 전망이 좋아지므로, 일계일까.

외부 PDF 파일 사용

참고로 한 기사 에서는 workspace 바로 아래에 extra 폴더를 만들고 있습니다.
기기 매뉴얼이나 논문 등 PDF 형식으로 배포되는 경우가 많은 파일은 extra 폴더에 저장합니다.
Doxygen GUI에서는 여기 ↓에 경로를 씁니다.

같은 이름의 이미지 파일에주의

출력 대상 폴더가 계층화되어 있지 않기 때문에 같은 이름의 이미지 파일을 두 이미지 중 하나로 덮어 씁니다.

# 同名のtestimage.pngだが絵柄は違う
![](images/testimage.png)
![](images/sub/testimage.png)

2 종류의 도안 차이의 testimage.png 를 표시시키고 싶어도
출력처의 폴더에는 testimage.png 는 1 개 밖에 없기 때문에, 어느쪽의 도안 데이터가 다른 한쪽의 도안 데이터로 덧쓰기되고 있다.

어떻게 하는 것이 정답인가?

이 기사의 마지막 절입니다.

OpenCV도 doxygen을 사용하고 있기 때문에 잘하고 있다고 생각합니다.git pull 에서 doc 에서 jpg 파일을 검색하면
훌륭하게 파일명이 흩어져, 괜찮은 것 이미지명이 중복하지 않게 하고 있는 것처럼 보였습니다.


result.jpg 따위 신경을 쓰면 곧바로 같은 이미지를 만들어 버리겠지만・・・.

서브디렉토리로 나누어 같은 이미지명을 판별할 수 있도록 하는 방법은 없는 것인가.

조사해도 현시점에서는 먼이 밝지 않기 때문에 끝으로 합니다.
op