Skip to content

Commit

Permalink
Merge branch 'master' of github.com:doxygen/doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
doxygen committed Mar 5, 2023
2 parents 7826cd9 + bfc8b1b commit 2b9f286
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 2 deletions.
27 changes: 27 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
*~
.*sw?
\#*
.DS_Store

*.rej
*.orig

*.pro
/packages/rpm/doxygen.spec
*.idb
*.pdb

/doxygen_docs
/doxygen.tag
/build*
/qtools_docs
/warnings.log

tags

.idea

/examples/html/*
/examples/latex/*

Dockerfile
41 changes: 41 additions & 0 deletions .github/workflows/docker_publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Publish Docker package

on:
release:
types: [published]

env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Log in to the Container registry
uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

- name: Build and push Docker image
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
26 changes: 26 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
FROM ubuntu:focal AS builder

RUN apt-get update && apt-get install -y \
g++ \
python \
cmake \
flex \
bison \
&& rm -rf /var/lib/apt/lists/*

WORKDIR /doxygen
COPY . .

RUN mkdir build \
&& cd build \
&& cmake -G "Unix Makefiles" .. \
&& make \
&& make install


FROM ubuntu:focal
RUN apt-get update && apt-get install --no-install-recommends -y \
graphviz \
&& rm -rf /var/lib/apt/lists/*
COPY --from=builder /doxygen/build/bin/doxygen /usr/local/bin/
ENTRYPOINT ["doxygen"]
8 changes: 6 additions & 2 deletions doc/commands.doc
Original file line number Diff line number Diff line change
Expand Up @@ -952,7 +952,11 @@ Structural indicators

If the documentation for the overloaded member function is not located
in front of the function declaration or definition, the optional
argument should be used to specify the correct function.
argument should be used to specify the correct declaration of the
overloaded function. Of course when the `\overload` command is directly
in front of the overloaded member function and the optional argument is
used this should also be the correct declaration of the overloaded
function.

Any other documentation that is inside the documentation block will
by appended after the generated message.
Expand All @@ -963,7 +967,7 @@ Structural indicators
To prevent that document reorders the documentation you should set
\ref cfg_sort_member_docs "SORT_MEMBER_DOCS" to \c NO in this case.
\par Note 2:
The \c \\overload command does not work inside a one-line comment.
Only one `\overload` command can be present in a comment block.
\par Example:
\include overload.cpp
\htmlonly
Expand Down

0 comments on commit 2b9f286

Please sign in to comment.