Opened 12 years ago

Closed 12 years ago

#512 closed request (fixed)

use doxygen tag \relates

Reported by: Peter Owned by: Peter
Priority: major Milestone: yat 0.6
Component: documentation Version: trunk
Keywords: Cc:

Description (last modified by Peter)

Use \relates or perhaps \relatesalso on free functions that are very tightly connected with a class. For instance, max(const Matrix) deserves this tag, and doxygen will list the free function in a section of the class entitled Related functions.

This relates to many classes. If a free function is declared in a class header file, then the function clearly the function relates to that class.

Change History (5)

comment:1 Changed 12 years ago by Peter

Description: modified (diff)

comment:2 Changed 12 years ago by Peter

(In [1883]) refs #512. added relates and relatesalso tags on some free functions in namespace classifier.

comment:3 Changed 12 years ago by Peter

(In [1885]) refs #512. added relates tag in namespace regression.

comment:4 Changed 12 years ago by Peter

(In [1886]) refs #512. added relates tag in namespace statistics.

comment:5 Changed 12 years ago by Peter

Resolution: fixed
Status: newclosed

(In [1887]) closes #512. added relates tag in namespace utility.

Note: See TracTickets for help on using tickets.