devel/ccdoc 0.8r41_1 DragonFly

Extracting comments from C++ source and generating HTML

System: DragonFly
Repository: DPorts
Maintainer: [email protected] (as in FreeBSD)
License: MIT
Categories: devel, textproc
Package size: 1392.6 KiB, 3024.5 KiB installed

Description

Ccdoc is a tool for extracting comments from C++ source code and presenting it in HTML format, very similar to Java's JavaDoc tool. The tagging used in ccdoc is very similar to that of Javadoc, with adaptations for the C++ specifics, of course. Ccdoc supports extracting comments from both header and implementation files.

In contrast to most other C++ doc'ing applications, ccdoc analyses the code before it has been run through the pre-processor, so things such as macros can actually be included in the documentation.

It's usage is not quite as straight forward as JavaDoc's, but considering the quality of the output, it is well worth the effort.

Install

Binary package:

pkg install ccdoc

From DPorts:

cd /usr/dports/devel/ccdoc && make install clean

Dependencies

Run dependencies 1

lang/perl5.36

No port depends on this one.

Configuration

No options to configure.

Service scripts: none

Message after installing

===>   NOTICE:

The ccdoc port currently does not have a maintainer. As a result, it is
more likely to have unresolved issues, not be up-to-date, or even be removed in
the future. To volunteer to maintain this port, please create an issue at:

https://bugs.freebsd.org/bugzilla

More information about port maintainership is available at:

https://docs.freebsd.org/en/articles/contributing/#ports-contributing

===>   NOTICE:

This port is deprecated; you may wish to reconsider installing it:

Obsolete utility.

It is scheduled to be removed on or after 2025-04-30.