#doxygen — Public Fediverse posts

Wer große APIs dokumentiert, kennt das Problem: Tutorials funktionieren gut — Referenzdokumentation oft weniger. Orientierung geht verloren. Willst du APIs schneller verstehen? @Stewori analysiert #Javadoc, #Doxygen & Sphinx mit #APIdia.

Lies: https://javapro.io/de/apidia-eine-neue-plattform-fuer-api-dokumentation/
@apidia_net

„Gut dokumentiert“ hilft wenig, wenn Entwickler die Struktur einer API nicht mehr erkennen können. Genau das kritisiert Stefan Richthofer an modernen Doku-Systemen!

Arbeitest du mit großen APIs? Dann lohnt sich der Blick auf #APIdia: https://javapro.io/de/apidia-eine-neue-plattform-fuer-api-dokumentation/

#Doxygen #Javadoc

Are you writing or maintaining an api doc generator for a programming language?

Lots of docs are served straight out of git. Please on't generate commit noise on every generated page.

- Don't generate a version number or time/date onto every page, stick it into the main page at most.
- Alternatively, use a CSS :before or :after rule to generate such content onto every page. Thereby only the changed CSS shows up in the commit.

Thanks.

#typedoc #javadoc #pydoctor #apidoc #doxygen

Are you writing or maintaining an api doc generator for a programming language?

Lots of docs are served straight out of git. Please on't generate commit noise on every generated page.

- Don't generate a version number or time/date onto every page, stick it into the main page at most.
- Alternatively, use a CSS :before or :after rule to generate such content onto every page. Thereby only the changed CSS shows up in the commit.

Thanks.

#typedoc #javadoc #pydoctor #apidoc #doxygen

https://pjotrek-b.github.io/Knowledge/doxygen_omekas

Put a pre-rendered copy of a freshly generated #OmekaS source code documentation in HTML.

Thanks #doxygen, and #omeka people!

https://pjotrek-b.github.io/Knowledge/doxygen_omekas

Put a pre-rendered copy of a freshly generated #OmekaS source code documentation in HTML.

Thanks #doxygen, and #omeka people!

https://pjotrek-b.github.io/Knowledge/doxygen_omekas

Put a pre-rendered copy of a freshly generated #OmekaS source code documentation in HTML.

Thanks #doxygen, and #omeka people!

https://pjotrek-b.github.io/Knowledge/doxygen_omekas

Put a pre-rendered copy of a freshly generated #OmekaS source code documentation in HTML.

Thanks #doxygen, and #omeka people!

Is there any way to convince Doxygen to use properly structured HTML tags?

By default Doxygen:
- Uses <div class="title"> instead of <h1> (and <h1> instead of <h2> etc.)
- Images are weird: They are placed in <div class="image">, and a <div class="caption"> (HTML has <figure> and <figcaption for this!) is used for the caption.
- All images have alt="", and the Alt-Text from Markdown is used as a caption instead. :neocat_confused:

#doxygen #accessibility

Is there any way to convince Doxygen to use properly structured HTML tags?

By default Doxygen:
- Uses <div class="title"> instead of <h1> (and <h1> instead of <h2> etc.)
- Images are weird: They are placed in <div class="image">, and a <div class="caption"> (HTML has <figure> and <figcaption for this!) is used for the caption.
- All images have alt="", and the Alt-Text from Markdown is used as a caption instead. :neocat_confused:

#doxygen #accessibility

Is there any way to convince Doxygen to use properly structured HTML tags?

By default Doxygen:
- Uses <div class="title"> instead of <h1> (and <h1> instead of <h2> etc.)
- Images are weird: They are placed in <div class="image">, and a <div class="caption"> (HTML has <figure> and <figcaption for this!) is used for the caption.
- All images have alt="", and the Alt-Text from Markdown is used as a caption instead. :neocat_confused:

#doxygen #accessibility

Is there any way to convince Doxygen to use properly structured HTML tags?

By default Doxygen:
- Uses <div class="title"> instead of <h1> (and <h1> instead of <h2> etc.)
- Images are weird: They are placed in <div class="image">, and a <div class="caption"> (HTML has <figure> and <figcaption for this!) is used for the caption.
- All images have alt="", and the Alt-Text from Markdown is used as a caption instead. :neocat_confused:

#doxygen #accessibility

Is there any way to convince Doxygen to use properly structured HTML tags?

By default Doxygen:
- Uses <div class="title"> instead of <h1> (and <h1> instead of <h2> etc.)
- Images are weird: They are placed in <div class="image">, and a <div class="caption"> (HTML has <figure> and <figcaption for this!) is used for the caption.
- All images have alt="", and the Alt-Text from Markdown is used as a caption instead. :neocat_confused:

#doxygen #accessibility

Recently, we talked about #libid3tag and our intent to make a new release. So far, we have a preview of some changes that have already been made in the latest main:

- Mojibake fixes for #UTF-16 (no BOM) encoded fields.
- Some code cleanups, including warning fixes.
- Compatibility with #CMake > 4.0 (we now require CMake 3.10+)

Meanwhile, we are also working on #Doxygen documentation to better document the library too, so quite a few things are going on for libid3tag right now.

Recently, we talked about #libid3tag and our intent to make a new release. So far, we have a preview of some changes that have already been made in the latest main:

- Mojibake fixes for #UTF-16 (no BOM) encoded fields.
- Some code cleanups, including warning fixes.
- Compatibility with #CMake > 4.0 (we now require CMake 3.10+)

Meanwhile, we are also working on #Doxygen documentation to better document the library too, so quite a few things are going on for libid3tag right now.

Recently, we talked about #libid3tag and our intent to make a new release. So far, we have a preview of some changes that have already been made in the latest main:

- Mojibake fixes for #UTF-16 (no BOM) encoded fields.
- Some code cleanups, including warning fixes.
- Compatibility with #CMake > 4.0 (we now require CMake 3.10+)

Meanwhile, we are also working on #Doxygen documentation to better document the library too, so quite a few things are going on for libid3tag right now.

Recently, we talked about #libid3tag and our intent to make a new release. So far, we have a preview of some changes that have already been made in the latest main:

- Mojibake fixes for #UTF-16 (no BOM) encoded fields.
- Some code cleanups, including warning fixes.
- Compatibility with #CMake > 4.0 (we now require CMake 3.10+)

Meanwhile, we are also working on #Doxygen documentation to better document the library too, so quite a few things are going on for libid3tag right now.

Recently, we talked about #libid3tag and our intent to make a new release. So far, we have a preview of some changes that have already been made in the latest main:

- Mojibake fixes for #UTF-16 (no BOM) encoded fields.
- Some code cleanups, including warning fixes.
- Compatibility with #CMake > 4.0 (we now require CMake 3.10+)

Meanwhile, we are also working on #Doxygen documentation to better document the library too, so quite a few things are going on for libid3tag right now.

@raiderrobert Using #Doxygen, set to estract all. Gives you a nice, clickable HTML version of the code, with inheritance and usage diagrams.

https://www.doxygen.nl

@raiderrobert Using #Doxygen, set to estract all. Gives you a nice, clickable HTML version of the code, with inheritance and usage diagrams.

https://www.doxygen.nl

@raiderrobert Using #Doxygen, set to estract all. Gives you a nice, clickable HTML version of the code, with inheritance and usage diagrams.

https://www.doxygen.nl

@raiderrobert Using #Doxygen, set to estract all. Gives you a nice, clickable HTML version of the code, with inheritance and usage diagrams.

https://www.doxygen.nl

@raiderrobert Using #Doxygen, set to estract all. Gives you a nice, clickable HTML version of the code, with inheritance and usage diagrams.

https://www.doxygen.nl

I'm working on a project which includes files written in both C and #Lisp; I'd like to have a common documentation generator for the whole project, to generate integrated documentation.

Has anyone made #Doxygen work with Lisp? Are there any recommendations for a documentation generator which can work for both (and also Markdown, which is what my specification docs are written in?

I'm working on a project which includes files written in both C and #Lisp; I'd like to have a common documentation generator for the whole project, to generate integrated documentation.

Has anyone made #Doxygen work with Lisp? Are there any recommendations for a documentation generator which can work for both (and also Markdown, which is what my specification docs are written in?

I'm working on a project which includes files written in both C and #Lisp; I'd like to have a common documentation generator for the whole project, to generate integrated documentation.

Has anyone made #Doxygen work with Lisp? Are there any recommendations for a documentation generator which can work for both (and also Markdown, which is what my specification docs are written in?

I'm working on a project which includes files written in both C and #Lisp; I'd like to have a common documentation generator for the whole project, to generate integrated documentation.

Has anyone made #Doxygen work with Lisp? Are there any recommendations for a documentation generator which can work for both (and also Markdown, which is what my specification docs are written in?

I'm working on a project which includes files written in both C and #Lisp; I'd like to have a common documentation generator for the whole project, to generate integrated documentation.

Has anyone made #Doxygen work with Lisp? Are there any recommendations for a documentation generator which can work for both (and also Markdown, which is what my specification docs are written in?

All new files my old `btrfs` filesystem creates are above 32-bit inode space:

$ touch a && stat '-c%i' a
11833717710

Very occasionally I build 32-bit `i686-linux` packages. Sometimes they fail to run against file with so large inodes.

Two casualties today:
- `doxygen`: https://github.com/doxygen/doxygen/pull/11518
- `graphviz`: https://gitlab.com/graphviz/graphviz/-/merge_requests/4269

#doxygen #graphviz #bug

All new files my old `btrfs` filesystem creates are above 32-bit inode space:

$ touch a && stat '-c%i' a
11833717710

Very occasionally I build 32-bit `i686-linux` packages. Sometimes they fail to run against file with so large inodes.

Two casualties today:
- `doxygen`: https://github.com/doxygen/doxygen/pull/11518
- `graphviz`: https://gitlab.com/graphviz/graphviz/-/merge_requests/4269

#doxygen #graphviz #bug

All new files my old `btrfs` filesystem creates are above 32-bit inode space:

$ touch a && stat '-c%i' a
11833717710

Very occasionally I build 32-bit `i686-linux` packages. Sometimes they fail to run against file with so large inodes.

Two casualties today:
- `doxygen`: https://github.com/doxygen/doxygen/pull/11518
- `graphviz`: https://gitlab.com/graphviz/graphviz/-/merge_requests/4269

#doxygen #graphviz #bug

All new files my old `btrfs` filesystem creates are above 32-bit inode space:

$ touch a && stat '-c%i' a
11833717710

Very occasionally I build 32-bit `i686-linux` packages. Sometimes they fail to run against file with so large inodes.

Two casualties today:
- `doxygen`: https://github.com/doxygen/doxygen/pull/11518
- `graphviz`: https://gitlab.com/graphviz/graphviz/-/merge_requests/4269

#doxygen #graphviz #bug

All new files my old `btrfs` filesystem creates are above 32-bit inode space:

$ touch a && stat '-c%i' a
11833717710

Very occasionally I build 32-bit `i686-linux` packages. Sometimes they fail to run against file with so large inodes.

Two casualties today:
- `doxygen`: https://github.com/doxygen/doxygen/pull/11518
- `graphviz`: https://gitlab.com/graphviz/graphviz/-/merge_requests/4269

#doxygen #graphviz #bug

Правильный путь создания python-библиотеки: от создания до публикации

Привет, Хабр! Стоит ли говорить, что Python ОЧЕНЬ и ОЧЕНЬ популярный язык программирования, местами даже догоняя JavaScript. Python в мире программирования — это эсперанто, легкий язык созданный для всех, но его владельцам не мешало бы помыться. В мире программирования создание собственных библиотек — это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом. Если вы ловили себя на мысли: «А почему мне бы не создать свою полноценную библиотеку?», то я рекомендую прочитать вам мою статью. Эту статью вы можете использовать как шпаргалку для создания своих python-библиотек. Я полностью расскажу все этапы создания библиотеки: документация, тестирование, архитектура, публикация и управление зависимостями Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу — сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?

https://habr.com/ru/companies/timeweb/articles/847370/

#python #poetry #pyproject #документация #doxygen #тестирование #unittest #pytest #библиотека #timeweb_статьи

Правильный путь создания python-библиотеки: от создания до публикации

Привет, Хабр! Стоит ли говорить, что Python ОЧЕНЬ и ОЧЕНЬ популярный язык программирования, местами даже догоняя JavaScript. Python в мире программирования — это эсперанто, легкий язык созданный для всех, но его владельцам не мешало бы помыться. В мире программирования создание собственных библиотек — это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом. Если вы ловили себя на мысли: «А почему мне бы не создать свою полноценную библиотеку?», то я рекомендую прочитать вам мою статью. Эту статью вы можете использовать как шпаргалку для создания своих python-библиотек. Я полностью расскажу все этапы создания библиотеки: документация, тестирование, архитектура, публикация и управление зависимостями Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу — сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?

https://habr.com/ru/companies/timeweb/articles/847370/

#python #poetry #pyproject #документация #doxygen #тестирование #unittest #pytest #библиотека #timeweb_статьи

Правильный путь создания python-библиотеки: от создания до публикации

Привет, Хабр! Стоит ли говорить, что Python ОЧЕНЬ и ОЧЕНЬ популярный язык программирования, местами даже догоняя JavaScript. Python в мире программирования — это эсперанто, легкий язык созданный для всех, но его владельцам не мешало бы помыться. В мире программирования создание собственных библиотек — это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом. Если вы ловили себя на мысли: «А почему мне бы не создать свою полноценную библиотеку?», то я рекомендую прочитать вам мою статью. Эту статью вы можете использовать как шпаргалку для создания своих python-библиотек. Я полностью расскажу все этапы создания библиотеки: документация, тестирование, архитектура, публикация и управление зависимостями Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу — сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?

https://habr.com/ru/companies/timeweb/articles/847370/

#python #poetry #pyproject #документация #doxygen #тестирование #unittest #pytest #библиотека #timeweb_статьи

Правильный путь создания python-библиотеки: от создания до публикации

Привет, Хабр! Стоит ли говорить, что Python ОЧЕНЬ и ОЧЕНЬ популярный язык программирования, местами даже догоняя JavaScript. Python в мире программирования — это эсперанто, легкий язык созданный для всех, но его владельцам не мешало бы помыться. В мире программирования создание собственных библиотек — это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом. Если вы ловили себя на мысли: «А почему мне бы не создать свою полноценную библиотеку?», то я рекомендую прочитать вам мою статью. Эту статью вы можете использовать как шпаргалку для создания своих python-библиотек. Я полностью расскажу все этапы создания библиотеки: документация, тестирование, архитектура, публикация и управление зависимостями Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу — сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?

https://habr.com/ru/companies/timeweb/articles/847370/

#python #poetry #pyproject #документация #doxygen #тестирование #unittest #pytest #библиотека #timeweb_статьи

Создаем свою простую (C++) библиотеку с документацией, CMake и блекджеком

В мире программирования создание собственных библиотек — это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом. Если вы ловили себя на мысли: ‭«А почему мне бы не создать свою полноценную библиотеку?‭», то я рекомендую прочитать вам мою статью. Эту статью вы можете использовать как шпаргалку для создания проектов, и не только библиотек. Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу — сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?

https://habr.com/ru/companies/timeweb/articles/845074/

#C++ #doxygen #open_source #github #библиотека #туториал #создание_библиотеки #создание_проекта #cmake

Создаем свою простую (C++) библиотеку с документацией, CMake и блекджеком

В мире программирования создание собственных библиотек — это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом. Если вы ловили себя на мысли: ‭«А почему мне бы не создать свою полноценную библиотеку?‭», то я рекомендую прочитать вам мою статью. Эту статью вы можете использовать как шпаргалку для создания проектов, и не только библиотек. Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу — сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?

https://habr.com/ru/companies/timeweb/articles/845074/

#C++ #doxygen #open_source #github #библиотека #туториал #создание_библиотеки #создание_проекта #cmake

Создаем свою простую (C++) библиотеку с документацией, CMake и блекджеком

В мире программирования создание собственных библиотек — это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом. Если вы ловили себя на мысли: ‭«А почему мне бы не создать свою полноценную библиотеку?‭», то я рекомендую прочитать вам мою статью. Эту статью вы можете использовать как шпаргалку для создания проектов, и не только библиотек. Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу — сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?

https://habr.com/ru/companies/timeweb/articles/845074/

#C++ #doxygen #open_source #github #библиотека #туториал #создание_библиотеки #создание_проекта #cmake

@debacle @alienghic I wish there was a package for those projects that use #Doxygen or those that #Qt's #QDoc.
Some projects such as KDE use docbooks, there's a rudamentary mode for them:
https://elpa.gnu.org/packages/docbook.html

With doxygen , Qt or Pythons API doc doc the documentation often doesn't really look like a manual like in Info mode I think there
should be a separate mode for such to view them or something that makes them easier to view in a single page per object.

@debacle @alienghic I wish there was a package for those projects that use #Doxygen or those that #Qt's #QDoc.
Some projects such as KDE use docbooks, there's a rudamentary mode for them:
https://elpa.gnu.org/packages/docbook.html

With doxygen , Qt or Pythons API doc doc the documentation often doesn't really look like a manual like in Info mode I think there
should be a separate mode for such to view them or something that makes them easier to view in a single page per object.

@debacle @alienghic I wish there was a package for those projects that use #Doxygen or those that #Qt's #QDoc.
Some projects such as KDE use docbooks, there's a rudamentary mode for them:
https://elpa.gnu.org/packages/docbook.html

With doxygen , Qt or Pythons API doc doc the documentation often doesn't really look like a manual like in Info mode I think there
should be a separate mode for such to view them or something that makes them easier to view in a single page per object.

@debacle @alienghic I wish there was a package for those projects that use #Doxygen or those that #Qt's #QDoc.
Some projects such as KDE use docbooks, there's a rudamentary mode for them:
https://elpa.gnu.org/packages/docbook.html

With doxygen , Qt or Pythons API doc doc the documentation often doesn't really look like a manual like in Info mode I think there
should be a separate mode for such to view them or something that makes them easier to view in a single page per object.

@debacle @alienghic I wish there was a package for those projects that use #Doxygen or those that #Qt's #QDoc.
Some projects such as KDE use docbooks, there's a rudamentary mode for them:
https://elpa.gnu.org/packages/docbook.html

With doxygen , Qt or Pythons API doc doc the documentation often doesn't really look like a manual like in Info mode I think there
should be a separate mode for such to view them or something that makes them easier to view in a single page per object.

The s390x open source team at IBM confirms the latest versions of various software packages run well on #Linux on #IBMZ & #LinuxONE

In June 2024 validation was maintained for over 30 projects, including: #CockroachDB #doxygen & #HashiCorp's #Terraform

Also, the AI/ML team at #IBM did initial work focused on s390x compatibility for Mage AI & the Triton Inference Server received compatibility fixes for big endian platforms.

Full report at: https://community.ibm.com/community/user/ibmz-and-linuxone/blogs/elizabeth-k-joseph1/2024/07/19/linuxone-open-source-report-june-2024

The s390x open source team at IBM confirms the latest versions of various software packages run well on #Linux on #IBMZ & #LinuxONE

In June 2024 validation was maintained for over 30 projects, including: #CockroachDB #doxygen & #HashiCorp's #Terraform

Also, the AI/ML team at #IBM did initial work focused on s390x compatibility for Mage AI & the Triton Inference Server received compatibility fixes for big endian platforms.

Full report at: https://community.ibm.com/community/user/ibmz-and-linuxone/blogs/elizabeth-k-joseph1/2024/07/19/linuxone-open-source-report-june-2024

The s390x open source team at IBM confirms the latest versions of various software packages run well on #Linux on #IBMZ & #LinuxONE

In June 2024 validation was maintained for over 30 projects, including: #CockroachDB #doxygen & #HashiCorp's #Terraform

Also, the AI/ML team at #IBM did initial work focused on s390x compatibility for Mage AI & the Triton Inference Server received compatibility fixes for big endian platforms.

Full report at: https://community.ibm.com/community/user/ibmz-and-linuxone/blogs/elizabeth-k-joseph1/2024/07/19/linuxone-open-source-report-june-2024

The s390x open source team at IBM confirms the latest versions of various software packages run well on #Linux on #IBMZ & #LinuxONE

In June 2024 validation was maintained for over 30 projects, including: #CockroachDB #doxygen & #HashiCorp's #Terraform

Also, the AI/ML team at #IBM did initial work focused on s390x compatibility for Mage AI & the Triton Inference Server received compatibility fixes for big endian platforms.

Full report at: https://community.ibm.com/community/user/ibmz-and-linuxone/blogs/elizabeth-k-joseph1/2024/07/19/linuxone-open-source-report-june-2024

The s390x open source team at IBM confirms the latest versions of various software packages run well on #Linux on #IBMZ & #LinuxONE

In June 2024 validation was maintained for over 30 projects, including: #CockroachDB #doxygen & #HashiCorp's #Terraform

Also, the AI/ML team at #IBM did initial work focused on s390x compatibility for Mage AI & the Triton Inference Server received compatibility fixes for big endian platforms.

Full report at: https://community.ibm.com/community/user/ibmz-and-linuxone/blogs/elizabeth-k-joseph1/2024/07/19/linuxone-open-source-report-june-2024