Opened 15 years ago

Closed 15 years ago

#133 closed defect (fixed)

documentation bugs

Reported by: Markus Ringnér Owned by: Peter
Priority: major Milestone: yat 0.3 (Public release)
Component: documentation Version:
Keywords: Cc:

Description (last modified by Markus Ringnér)

There are a bunch of comments that produce errors in the documentation. Many of these appear after issuing a 'make clean' in the doc-directory followed by a 'make doc' in the top-level directory.

Some appear as Latex errors: PolynomialKernelFunction?.h has a frac with only nominator: \frac{\sum w_yxy}

But more importantly if there is a "\f$ some equation stuff" but the ending \f$ is missing then the entire function that is being commented becomes completely left out by doxygen. Leaving documentation readers with incomplete interfaces to classes.

I think one should do a 'make clean; make doc >& out' and look for all lines with 'Warning' in them a regular habit.

Also one should look at the documentation as many formulas cross one line in documentation with / format, which leaves a lot of erroneous / in the final documentation.

Change History (3)

comment:1 Changed 15 years ago by Markus Ringnér

Description: modified (diff)

comment:2 Changed 15 years ago by Markus Ringnér

Description: modified (diff)

comment:3 Changed 15 years ago by Peter

Resolution: fixed
Status: newclosed

(In [648]) fixes #133 removed all errors reported from Doxygen. Only one error left which says Index is not documented but I don't want it to be documented actually we use the Doxygens preprocessor to skip documenting that class, yet Doxygen complains that class is not documented huh. Only solution would be to move that class to its own file and not keep it together with SVM.

Note: See TracTickets for help on using tickets.