stan-dev / stan-dev/math

clean up Doxygen

Open
#2,687 0 comments 0 reactions 1 assignee View on GitHub

@bob-carpenter is already working on this.

Since Apr 21, 2022.

  • #2745 by @SteveBronder — closed without merging
bug code cleanup doc good first issue
Dominant language
C++
Stars
839
Forks
220
Avg merge
2d 4h
Merged PRs (30d)
14

Description

Description

Describe the issue as clearly as possible. Issues are meant for bug reports and feature requests. The issue should contain enough information for a developer to put together a solution.

If this is a general question, please post to the forums.

Example

Here's the current errors.

mkdir -p doc/api
doxygen doxygen/doxygen.cfg
warning: Tag 'TCL_SUBST' at line 237 of file 'doxygen/doxygen.cfg' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1053 of file 'doxygen/doxygen.cfg' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1758 of file 'doxygen/doxygen.cfg' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1840 of file 'doxygen/doxygen.cfg' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2132 of file 'doxygen/doxygen.cfg' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

and so on for thousands of lines. So many that trying to post them all says

There was an error creating your Issue: body is too long (maximum is 65536 characters).

Expected Output

No errors

Current Version:

v4.3.1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.