use doxygen-awesome css theme#3351
Conversation
User selectable) |
syurkevi
force-pushed
the
doxygen-awesome
branch
from
377ad70 to
bdb018d
Compare
|
LGTM @umar456 ? |
|
@syurkevi Since you are at improving docs, can also please remove the following old doxygen configurations. Also, the results of the search typing are coming up in white color with white background here. The screenshot doesn't do justice but do try it and see. |
| \ingroup arith_mat | ||
|
|
||
| Addition of two inputs. | ||
| Add two arrays. |
There was a problem hiding this comment.
We have several operator+ overloads can accept both arrays and value types(int, float, etc.). This change makes it seem like we can only accept array types.
Additional information can include casting behavior. See me for details when you get to it.
| __Examples:__ | ||
|
|
||
| Absolute value | ||
| \snippet test/math.cpp ex_arith_func_abs |
There was a problem hiding this comment.
This sample doesn't exist. You need to add the test/math.cpp tests to this PR.
| \ingroup numeric_mat | ||
|
|
||
| Round to integer less than equal to current value | ||
| Round to the integer less than or equal to the magnitude of the input value. |
There was a problem hiding this comment.
This explanation sounds confusing for floor. Can't we just say round down to the nearest integer?
| \ingroup numeric_mat | ||
|
|
||
| Round to integer greater than equal to current value | ||
| Round to the integer greater than or equal to the magnitude of the input value. |
There was a problem hiding this comment.
This explanation sounds confusing. Can't we just say round up to the nearest integer?
| \ingroup numeric_mat | ||
|
|
||
| Hypotenuse of the two inputs | ||
| Find the length of the hypotenuse of two inputs. |
There was a problem hiding this comment.
Perhaps add a LaTeX formula for this?
| \return \ref AF_SUCCESS if the execution completes properly | ||
|
|
||
| \ingroup arith_func_exp | ||
| \note Computes `1/(1+e^-x)`. |
| \param[in] d3 is size of fourth dimension | ||
| \param[in] seq_dim is dimesion along which [0, dim[seq_dim] - 1] is generated | ||
| \param[in] ty is the type of array to generate | ||
| * C++ Interface for creating an array with `[0, n-1]` values along the `seq_dim` dimension and tiled across other dimensions described by dimension parameters. |
There was a problem hiding this comment.
This should be a brief description. I think the second part should be part of the body of this function if not put in the dox file associated with this function.
| // 1, 3, 5] | ||
|
|
||
| // Create b by summing across the first dimension | ||
| array b = sum(a); // sum across the first dimension, same as sum(a, 0) |
There was a problem hiding this comment.
This should show the result of the computation in the example
There was a problem hiding this comment.
Not super useful for this shape of an array. It will just return the same value as the input.
syurkevi
force-pushed
the
doxygen-awesome
branch
from
094e00a to
f5ae7ed
Compare
4 participants
Change documentation theme to use doxygen-awesome
Hoping to improve readability and provide the foundation for a number of inbound documentation improvements 🤞
This change bumps the doxygen.mk to 1.9.5. May still need some tweaks with the searchbar, need to test on arrayfire.org.
Sidebar, lightmode/darkmode, and function preview below:
