Add Doxygen support
This commit is contained in:
Pascal Serrarens
parent
2eaeb7d726
commit
08378db856
2682
DoxyGen/Doxyfile
Normal file
2682
DoxyGen/Doxyfile
Normal file
File diff suppressed because it is too large
Load Diff
226
DoxyGen/DoxygenLayout.xml
Normal file
226
DoxyGen/DoxygenLayout.xml
Normal file
@ -0,0 +1,226 @@
|
||||
<doxygenlayout version="1.0">
|
||||
<!-- Generated by doxygen 1.8.18 -->
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="yes" title=""/>
|
||||
<tab type="pages" visible="yes" title="" intro=""/>
|
||||
<tab type="modules" visible="yes" title="" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="interfaces" visible="yes" title="">
|
||||
<tab type="interfacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="classes" visible="yes" title="">
|
||||
<tab type="classlist" visible="yes" title="" intro=""/>
|
||||
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="hierarchy" visible="yes" title="" intro=""/>
|
||||
<tab type="classmembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="structs" visible="yes" title="">
|
||||
<tab type="structlist" visible="yes" title="" intro=""/>
|
||||
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
</tab>
|
||||
<tab type="exceptions" visible="yes" title="">
|
||||
<tab type="exceptionlist" visible="yes" title="" intro=""/>
|
||||
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="files" visible="yes" title="">
|
||||
<tab type="filelist" visible="yes" title="" intro=""/>
|
||||
<tab type="globals" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="examples" visible="yes" title="" intro=""/>
|
||||
</navindex>
|
||||
|
||||
<!-- Layout definition for a class page -->
|
||||
<class>
|
||||
<briefdescription visible="no"/>
|
||||
<detaileddescription title="Unity Inspector"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<inheritancegraph visible="$CLASS_GRAPH"/>
|
||||
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
||||
<memberdecl>
|
||||
<nestedclasses visible="yes" title=""/>
|
||||
<publictypes title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<publicslots title=""/>
|
||||
<signals title=""/>
|
||||
<publicmethods title=""/>
|
||||
<publicstaticmethods title=""/>
|
||||
<publicattributes title=""/>
|
||||
<publicstaticattributes title=""/>
|
||||
<protectedtypes title=""/>
|
||||
<protectedslots title=""/>
|
||||
<protectedmethods title=""/>
|
||||
<protectedstaticmethods title=""/>
|
||||
<protectedattributes title=""/>
|
||||
<protectedstaticattributes title=""/>
|
||||
<packagetypes title=""/>
|
||||
<packagemethods title=""/>
|
||||
<packagestaticmethods title=""/>
|
||||
<packageattributes title=""/>
|
||||
<packagestaticattributes title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
<privatetypes title=""/>
|
||||
<privateslots title=""/>
|
||||
<privatemethods title=""/>
|
||||
<privatestaticmethods title=""/>
|
||||
<privateattributes title=""/>
|
||||
<privatestaticattributes title=""/>
|
||||
<friends title=""/>
|
||||
<related title="" subtitle=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<constructors title=""/>
|
||||
<functions title=""/>
|
||||
<related title=""/>
|
||||
<variables title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
</memberdef>
|
||||
<allmemberslink visible="yes"/>
|
||||
<usedfiles visible="$SHOW_USED_FILES"/>
|
||||
<authorsection visible="yes"/>
|
||||
</class>
|
||||
|
||||
<!-- Layout definition for a namespace page -->
|
||||
<namespace>
|
||||
<briefdescription visible="yes"/>
|
||||
<memberdecl>
|
||||
<nestednamespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<interfaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<structs visible="yes" title=""/>
|
||||
<exceptions visible="yes" title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</namespace>
|
||||
|
||||
<!-- Layout definition for a file page -->
|
||||
<file>
|
||||
<briefdescription visible="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<includegraph visible="$INCLUDE_GRAPH"/>
|
||||
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
|
||||
<sourcelink visible="yes"/>
|
||||
<memberdecl>
|
||||
<interfaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<structs visible="yes" title=""/>
|
||||
<exceptions visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection/>
|
||||
</file>
|
||||
|
||||
<!-- Layout definition for a group page -->
|
||||
<group>
|
||||
<briefdescription visible="yes"/>
|
||||
<groupgraph visible="$GROUP_GRAPHS"/>
|
||||
<memberdecl>
|
||||
<nestedgroups visible="yes" title=""/>
|
||||
<dirs visible="yes" title=""/>
|
||||
<files visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<pagedocs/>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</group>
|
||||
|
||||
<!-- Layout definition for a directory page -->
|
||||
<directory>
|
||||
<briefdescription visible="yes"/>
|
||||
<directorygraph visible="yes"/>
|
||||
<memberdecl>
|
||||
<dirs visible="yes"/>
|
||||
<files visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
</directory>
|
||||
</doxygenlayout>
|
||||
12
DoxyGen/custom_doxygen.css
Normal file
12
DoxyGen/custom_doxygen.css
Normal file
@ -0,0 +1,12 @@
|
||||
/* Custom PasserVR CSS for DoxyGen */
|
||||
|
||||
a {
|
||||
color: #e77505;
|
||||
}
|
||||
.contents a:visited {
|
||||
color: #e77505;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #10659C;
|
||||
}
|
||||
60
DoxyWarnLogfile.txt
Normal file
60
DoxyWarnLogfile.txt
Normal file
@ -0,0 +1,60 @@
|
||||
warning: source 'images' is not a readable file or directory... skipping.
|
||||
D:/C/VectorAlgebra/Quaternion.h:24: warning: Member Quaternion(float _x, float _y, float _z, float _w) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:25: warning: Member Quaternion(Vector3 _xyz, float _w) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:26: warning: Member Quaternion(Quat q) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:31: warning: Member GetLength() const (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:32: warning: Member GetLengthSquared() const (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:34: warning: Member Normalize() (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:42: warning: Member operator*(const Vector3 &p) const (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:43: warning: Member operator*(const Quaternion &r2) const (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:45: warning: Member operator==(const Quaternion &q) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:56: warning: Member ToAngleAxis(float *angle, Vector3 *axis) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:69: warning: Member xyz() const (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:33: warning: Member GetLengthSquared(const Quaternion &q) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:35: warning: Member Normalize(const Quaternion &q) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:36: warning: Member Normalize(const Quaternion &q, Quaternion &result) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:38: warning: Member Dot(Quaternion a, Quaternion b) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:40: warning: Member ToAngles(const Quaternion &q1) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:47: warning: Member Inverse(Quaternion r) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:49: warning: Member LookRotation(const Vector3 &forward, const Vector3 &upwards) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:52: warning: Member FromToRotation(Vector3 fromDirection, Vector3 toDirection) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:54: warning: Member RotateTowards(const Quaternion &from, const Quaternion &to, float maxDegreesDelta) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:55: warning: Member AngleAxis(float angle, const Vector3 &axis) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:57: warning: Member ToAxisAngleRad(const Quaternion &q, Vector3 *const axis, float *angle) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:58: warning: Member Angle(Quaternion a, Quaternion b) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:59: warning: Member Slerp(const Quaternion &a, const Quaternion &b, float t) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:60: warning: Member SlerpUnclamped(const Quaternion &a, const Quaternion &b, float t) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:62: warning: Member Euler(float x, float y, float z) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:63: warning: Member Euler(Vector3 euler) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:64: warning: Member FromEulerRad(Vector3 euler) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:65: warning: Member GetAngleAround(Vector3 axis, Quaternion rotation) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:66: warning: Member GetRotationAround(Vector3 axis, Quaternion rotation) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:67: warning: Member GetSwingTwist(Vector3 axis, Quaternion rotation, Quaternion *swing, Quaternion *twist) (function) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:9: warning: Member x (variable) of struct Quat is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:10: warning: Member y (variable) of struct Quat is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:11: warning: Member z (variable) of struct Quat is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:12: warning: Member w (variable) of struct Quat is not documented.
|
||||
D:/C/VectorAlgebra/Quaternion.h:29: warning: Member identity (variable) of struct Quaternion is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:71: warning: Member magnitude() const (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:73: warning: Member sqrMagnitude() const (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:75: warning: Member normalized() const (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:77: warning: Member operator-() (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:78: warning: Member operator-(const Vector3 &p2) const (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:80: warning: Member operator+(const Vector3 &t1) const (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:83: warning: Member operator*(float f) const (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:85: warning: Member operator/(const float &d) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:88: warning: Member operator==(const Vector3 &v) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:70: warning: Member Magnitude(const Vector3 &a) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:72: warning: Member SqrMagnitude(const Vector3 &a) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:74: warning: Member Normalize(Vector3 v) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:81: warning: Member Scale(const Vector3 &p1, const Vector3 &p2) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:86: warning: Member Dot(const Vector3 &v1, const Vector3 &v2) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:90: warning: Member Distance(const Vector3 &p1, const Vector3 &p2) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:91: warning: Member Cross(const Vector3 &v1, const Vector3 &v2) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:94: warning: Member Project(Vector3 vector, Vector3 onNormal) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:96: warning: Member ProjectOnPlane(Vector3 vector, Vector3 planeNormal) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:98: warning: Member Angle(Vector3 from, Vector3 to) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:99: warning: Member SignedAngle(Vector3 from, Vector3 to, Vector3 axis) (function) of struct Vector3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:9: warning: Member x (variable) of struct Vec3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:10: warning: Member y (variable) of struct Vec3 is not documented.
|
||||
D:/C/VectorAlgebra/Vector3.h:11: warning: Member z (variable) of struct Vec3 is not documented.
|
||||
@ -15,6 +15,9 @@ extern "C" {
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// A quaternion
|
||||
/// </summary>
|
||||
struct Quaternion : Quat {
|
||||
public:
|
||||
Quaternion();
|
||||
|
||||
13
README.md
13
README.md
@ -1 +1,12 @@
|
||||
3D Vector algebra library (Vector, Quaternion)
|
||||
\author PasserVR
|
||||
\version 0.1
|
||||
\mainpage Vector Algebra
|
||||
|
||||
3D Vector algebra library (Vector3, Quaternion)
|
||||
|
||||
Note: this documentation is still work in progress....
|
||||
|
||||
Main components
|
||||
---------------
|
||||
* Vector3
|
||||
* Quaternion
|
||||
41
Vector3.h
41
Vector3.h
@ -15,19 +15,56 @@ extern "C" {
|
||||
void CopyVec3(const Vec3& v1, Vec3& v2);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A 3-dimensional vector
|
||||
/// </summary>
|
||||
struct Vector3 : Vec3 {
|
||||
public:
|
||||
/// <summary>
|
||||
/// Create a new 3-dimensinal zero vector
|
||||
/// </summary>
|
||||
Vector3();
|
||||
Vector3(float _x, float _y, float _z);
|
||||
Vector3(Vec3 v);
|
||||
/// <summary>
|
||||
/// Create a new 3-dimensional vector
|
||||
/// </summary>
|
||||
/// <param name="x">x axis value</param>
|
||||
/// <param name="y">y axis value</param>
|
||||
/// <param name="z">z axis value</param>
|
||||
Vector3(float x, float y, float z);
|
||||
/// <summary>
|
||||
/// Create a vector from C-style Vec3
|
||||
/// </summary>
|
||||
/// <param name="v">The C-style Vec</param>
|
||||
Vector3(Vec3 v);
|
||||
~Vector3();
|
||||
|
||||
/// <summary>
|
||||
/// A vector with zero for all axis
|
||||
/// </summary>
|
||||
const static Vector3 zero;
|
||||
/// <summary>
|
||||
/// A vector with values (1, 0, 0)
|
||||
/// </summary>
|
||||
const static Vector3 right;
|
||||
/// <summary>
|
||||
/// A vector3 with values (-1, 0, 0)
|
||||
/// </summary>
|
||||
const static Vector3 left;
|
||||
/// <summary>
|
||||
/// A vector with values (0, 1, 0)
|
||||
/// </summary>
|
||||
const static Vector3 up;
|
||||
/// <summary>
|
||||
/// A vector with values (0, -1, 0)
|
||||
/// </summary>
|
||||
const static Vector3 down;
|
||||
/// <summary>
|
||||
/// A vector with values (0, 0, 1)
|
||||
/// </summary>
|
||||
const static Vector3 forward;
|
||||
/// <summary>
|
||||
/// A vector with values (0, 0, -1)
|
||||
/// </summary>
|
||||
const static Vector3 back;
|
||||
|
||||
static float Magnitude(const Vector3& a);
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user