Skip to content

Commit

Permalink
Doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
@lisitsyn
lisitsyn committed Aug 31, 2011
1 parent b23e6ba commit ceee77a
Show file tree
Hide file tree
Showing 43 changed files with 75 additions and 41 deletions.
6 changes: 4 additions & 2 deletions src/shogun/base/Parameter.h
View file
Expand Up @@ -18,7 +18,7 @@

namespace shogun
{
/** Parameter */
/** @brief parameter struct */
struct TParameter
{
/** explicit constructor
Expand Down Expand Up @@ -76,7 +76,9 @@ struct TParameter
const char* prefix);
};

/** Must not be an CSGObject to prevent a recursive call of
/** @brief Parameter class
*
* Must not be an CSGObject to prevent a recursive call of
* constructors.
*/
class Parameter
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/base/class_list.cpp.templ
View file
Expand Up @@ -24,11 +24,13 @@ REPLACE definitions THIS
REPLACE template_definitions THIS

typedef CSGObject* (*new_sgserializable_t)(EPrimitiveType generic);
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct
{
const char* m_class_name;
new_sgserializable_t m_new_sgserializable;
} class_list_entry_t;
#endif

static class_list_entry_t class_list[] = {
REPLACE struct THIS
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/classifier/svm/CPLEXSVM.h
View file
Expand Up @@ -18,8 +18,8 @@

namespace shogun
{
/** @brief CplexSVM a SVM solver implementation based on cplex (unfinished). */
#define IGNORE_IN_CLASSLIST
/** @brief CplexSVM a SVM solver implementation based on cplex (unfinished). */
IGNORE_IN_CLASSLIST class CCPLEXSVM : public CSVM
{
public:
Expand Down
4 changes: 2 additions & 2 deletions src/shogun/classifier/svm/LaRank.h
View file
Expand Up @@ -302,8 +302,8 @@ namespace shogun
#endif // DOXYGEN_SHOULD_SKIP_THIS


/**
* MACHINE: the main thing, which is trained.
/** @brief the LaRank multiclass SVM machine
*
*/
class CLaRank: public CMultiClassSVM
{
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/distributions/PositionalPWM.h
View file
Expand Up @@ -18,7 +18,7 @@

namespace shogun
{
/** Positional PWM */
/** @brief Positional PWM */
class CPositionalPWM : public CDistribution
{
public:
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/features/CombinedDotFeatures.h
View file
Expand Up @@ -161,6 +161,7 @@ class CCombinedDotFeatures : public CDotFeatures
return sizeof(float64_t);
}

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for combined dotfeatures */
struct combined_feature_iterator
{
Expand All @@ -173,6 +174,7 @@ class CCombinedDotFeatures : public CDotFeatures
/** the index of the vector over whose components to iterate over */
int32_t vector_index;
};
#endif

/** iterate over the non-zero features
*
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/features/ExplicitSpecFeatures.h
View file
Expand Up @@ -88,6 +88,7 @@ class CExplicitSpecFeatures : public CDotFeatures
*/
virtual void add_to_dense_vec(float64_t alpha, int32_t vec_idx1, float64_t* vec2, int32_t vec2_len, bool abs_val=false);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for weighted spectrum features */
struct explicit_spec_feature_iterator
{
Expand All @@ -104,6 +105,7 @@ class CExplicitSpecFeatures : public CDotFeatures
int32_t index;

};
#endif

/** iterate over the non-zero features
*
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/features/HashedWDFeatures.h
View file
Expand Up @@ -103,6 +103,7 @@ class CHashedWDFeatures: public CDotFeatures
return degree*vlen;
}

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for weighted spectrum features */
struct hashed_wd_feature_iterator
{
Expand All @@ -119,6 +120,7 @@ class CHashedWDFeatures: public CDotFeatures
int32_t index;

};
#endif

/** iterate over the non-zero features
*
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/features/HashedWDFeaturesTransposed.h
View file
Expand Up @@ -168,6 +168,7 @@ class CHashedWDFeaturesTransposed : public CDotFeatures
return normalization_const;
}

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for weighted spectrum features */
struct hashed_wd_transposed_feature_iterator
{
Expand All @@ -184,6 +185,7 @@ class CHashedWDFeaturesTransposed : public CDotFeatures
int32_t index;

};
#endif

/** iterate over the non-zero features
*
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/features/ImplicitWeightedSpecFeatures.h
View file
Expand Up @@ -157,6 +157,7 @@ class CImplicitWeightedSpecFeatures : public CDotFeatures
*/
bool set_weights(float64_t* w, int32_t d);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for weighted spectrum features */
struct wspec_feature_iterator
{
Expand All @@ -180,6 +181,7 @@ class CImplicitWeightedSpecFeatures : public CDotFeatures
float64_t alpha;
//@}
};
#endif

/** iterate over the non-zero features
*
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/features/PolyFeatures.h
View file
Expand Up @@ -147,6 +147,7 @@ class CPolyFeatures : public CDotFeatures
*/
void add_to_dense_vec(float64_t alpha, int32_t vec_idx1, float64_t* vec2, int32_t vec2_len, bool abs_val);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for weighted spectrum features */
struct poly_feature_iterator
{
Expand All @@ -163,6 +164,7 @@ class CPolyFeatures : public CDotFeatures
int32_t index;

};
#endif

/** iterate over the non-zero features
*
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/features/SimpleFeatures.h
View file
Expand Up @@ -882,6 +882,7 @@ template<class ST> class CSimpleFeatures: public CDotFeatures
*/
virtual inline void save(CFile* saver);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for simple features */
struct simple_feature_iterator
{
Expand All @@ -897,6 +898,7 @@ template<class ST> class CSimpleFeatures: public CDotFeatures
/** feature index */
int32_t index;
};
#endif

/** iterate over the non-zero features
*
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/features/SparseFeatures.h
View file
Expand Up @@ -1408,6 +1408,7 @@ template <class ST> class CSparseFeatures : public CDotFeatures
return result;
}

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for sparse features */
struct sparse_feature_iterator
{
Expand All @@ -1424,6 +1425,7 @@ template <class ST> class CSparseFeatures : public CDotFeatures
sv.features, sv.vec_index, sv.num_feat_entries, index);
}
};
#endif

/** iterate over the non-zero features
*
Expand Down
3 changes: 2 additions & 1 deletion src/shogun/features/SparsePolyFeatures.h
View file
Expand Up @@ -121,6 +121,7 @@ class CSparsePolyFeatures : public CDotFeatures
return sizeof(float64_t);
}

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for weighted spectrum features */
struct sparse_poly_feature_iterator
{
Expand All @@ -135,8 +136,8 @@ class CSparsePolyFeatures : public CDotFeatures

/** feature index */
int32_t index;

};
#endif

/** iterate over the non-zero features
*
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/features/WDFeatures.h
View file
Expand Up @@ -98,6 +98,7 @@ class CWDFeatures : public CDotFeatures
return degree*vlen;
}

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** iterator for weighted spectrum features */
struct wd_feature_iterator
{
Expand All @@ -124,6 +125,7 @@ class CWDFeatures : public CDotFeatures
int32_t o;
//@}
};
#endif

/** iterate over the non-zero features
*
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/io/SerializableAsciiFile.h
View file
Expand Up @@ -30,7 +30,7 @@

namespace shogun
{
/** serializable ascii file */
/** @brief serializable ascii file */
class CSerializableAsciiFile :public CSerializableFile
{
friend class SerializableAsciiReader00;
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/io/SerializableAsciiReader00.h
View file
Expand Up @@ -14,7 +14,7 @@

namespace shogun
{
/** serializable ascii reader 00 */
/** @brief Serializable ascii reader */
class SerializableAsciiReader00
: public CSerializableFile::TSerializableReader {

Expand Down
4 changes: 2 additions & 2 deletions src/shogun/io/SerializableFile.h
View file
Expand Up @@ -20,11 +20,11 @@ namespace shogun
{
class CSGObject;

/** serializable file */
/** @brief serializable file */
class CSerializableFile :public CSGObject
{
public:
/** serializable reader */
/** @brief serializable reader */
struct TSerializableReader :public CSGObject {

/* ******************************************************** */
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/kernel/ANOVAKernel.h
View file
Expand Up @@ -23,7 +23,7 @@ namespace shogun

class CDistance;

/** @brief ANOVA kernel
/** @brief ANOVA (ANalysis Of VAriances) kernel
*
* Formally described as
*
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/kernel/BesselKernel.h
View file
Expand Up @@ -18,7 +18,7 @@
namespace shogun
{
class CDistance;
/** the class Bessel kernel
/** @brief the class Bessel kernel
*
* It is defined as
* \f[
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/kernel/Kernel.h
View file
Expand Up @@ -122,6 +122,7 @@ enum EKernelProperty
KP_BATCHEVALUATION = 4 // Kernels that can on the fly generate normals in linadd and more quickly/memory efficient process batches instead of single examples
};

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** kernel thread parameters */
template <class T> struct K_THREAD_PARAM
{
Expand All @@ -146,6 +147,7 @@ template <class T> struct K_THREAD_PARAM
/** output progress */
bool verbose;
};
#endif

class CSVM;

Expand Down
2 changes: 1 addition & 1 deletion src/shogun/kernel/ScatterKernelNormalizer.h
View file
Expand Up @@ -19,7 +19,7 @@

namespace shogun
{
/** scatter kernel normalizer */
/** @brief the scatter kernel normalizer */
class CScatterKernelNormalizer: public CKernelNormalizer
{

Expand Down
6 changes: 4 additions & 2 deletions src/shogun/kernel/SpectrumMismatchRBFKernel.h
View file
Expand Up @@ -25,6 +25,7 @@
namespace shogun
{

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** joint list struct */
struct joint_list_struct
{
Expand All @@ -34,9 +35,10 @@ struct joint_list_struct
unsigned int index;
/** mismatch */
unsigned int mismatch;
} ;
};
#endif

/** spectrum mismatch rbf kernel */
/** @brief spectrum mismatch rbf kernel */
class CSpectrumMismatchRBFKernel: public CStringKernel<char>
{
public:
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/kernel/SpectrumRBFKernel.h
View file
Expand Up @@ -27,7 +27,7 @@
namespace shogun
{

/** spectrum rbf kernel */
/** @brief spectrum rbf kernel */
class CSpectrumRBFKernel: public CStringKernel<char>
{
public:
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/kernel/WaveletKernel.h
View file
Expand Up @@ -17,7 +17,7 @@

namespace shogun
{
/** the class WaveletKernel
/** @brief the class WaveletKernel
*
* It is defined as
*
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/kernel/WeightedDegreeRBFKernel.h
View file
Expand Up @@ -8,7 +8,7 @@
namespace shogun
{

/** weighted degree RBF kernel */
/** @brief weighted degree RBF kernel */
class CWeightedDegreeRBFKernel: public CDotKernel
{
public:
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/lib/Compressor.h
View file
Expand Up @@ -34,7 +34,7 @@ namespace shogun
};


/** Compression library for compressing and decompressing buffers using
/** @brief Compression library for compressing and decompressing buffers using
* one of the standard compression algorithms, LZO, GZIP, BZIP2 or LZMA.
*
* The general recommendation is to use LZO whenever lightweight compression
Expand Down

0 comments on commit ceee77a

Please sign in to comment.