← 返回首页
use doxygen-awesome css theme by syurkevi · Pull Request #3351 · arrayfire/arrayfire · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

use doxygen-awesome css theme#3351

Merged
umar456 merged 9 commits into
arrayfire:masterfrom
syurkevi:doxygen-awesome
Jan 24, 2023
Merged

use doxygen-awesome css theme#3351
umar456 merged 9 commits into
arrayfire:masterfrom
syurkevi:doxygen-awesome

Conversation

Copy link
Copy Markdown
Contributor

syurkevi commented Dec 20, 2022

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:

Copy link
Copy Markdown
Member

9prady9 commented Dec 20, 2022

Awesome theme change! could we switch to dark mode too ?

Copy link
Copy Markdown
Contributor Author

syurkevi commented Dec 20, 2022

Awesome theme change! could we switch to dark mode too ?

User selectable)

Copy link
Copy Markdown
Member

9prady9 commented Dec 24, 2022

LGTM @umar456 ?

Copy link
Copy Markdown
Member

9prady9 commented Dec 24, 2022

@syurkevi Since you are at improving docs, can also please remove the following old doxygen configurations.

warning: Tag 'CLANG_ASSISTED_PARSING' at line 1207 of file '/home/pradeep/gitroot/ArrayFireWorkspace/arrayfire/build/docs/doxygen.mk.out' belongs to an option that was not enabled at compile time. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled. warning: Tag 'CLANG_ADD_INC_PATHS' at line 1215 of file '/home/pradeep/gitroot/ArrayFireWorkspace/arrayfire/build/docs/doxygen.mk.out' belongs to an option that was not enabled at compile time. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled. warning: Tag 'CLANG_OPTIONS' at line 1223 of file '/home/pradeep/gitroot/ArrayFireWorkspace/arrayfire/build/docs/doxygen.mk.out' belongs to an option that was not enabled at compile time. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled. warning: Tag 'CLANG_DATABASE_PATH' at line 1236 of file '/home/pradeep/gitroot/ArrayFireWorkspace/arrayfire/build/docs/doxygen.mk.out' belongs to an option that was not enabled at compile time. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u", or recompile doxygen with this feature enabled.

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.

umar456 requested changes Jan 13, 2023
View reviewed changes
Comment thread docs/details/arith.dox Outdated
\ingroup arith_mat

Addition of two inputs.
Add two arrays.
Copy link
Copy Markdown
Member

umar456 Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide 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.

Comment thread docs/details/arith.dox Outdated
__Examples:__

Absolute value
\snippet test/math.cpp ex_arith_func_abs
Copy link
Copy Markdown
Member

umar456 Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

This sample doesn't exist. You need to add the test/math.cpp tests to this PR.

Comment thread docs/details/arith.dox Outdated
\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.
Copy link
Copy Markdown
Member

umar456 Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

This explanation sounds confusing for floor. Can't we just say round down to the nearest integer?

Comment thread docs/details/arith.dox Outdated
\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.
Copy link
Copy Markdown
Member

umar456 Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

This explanation sounds confusing. Can't we just say round up to the nearest integer?

Comment thread docs/details/arith.dox Outdated
\ingroup numeric_mat

Hypotenuse of the two inputs
Find the length of the hypotenuse of two inputs.
Copy link
Copy Markdown
Member

umar456 Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Perhaps add a LaTeX formula for this?

21 hidden conversations Load more…
Comment thread include/af/arith.h Outdated
\return \ref AF_SUCCESS if the execution completes properly

\ingroup arith_func_exp
\note Computes `1/(1+e^-x)`.
Copy link
Copy Markdown
Member

umar456 Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

This shouldn't be a note

Comment thread include/af/data.h
\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.
Copy link
Copy Markdown
Member

umar456 Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide 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.

Comment thread test/reduce.cpp
// 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)
Copy link
Copy Markdown
Member

umar456 Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

This should show the result of the computation in the example

Comment thread test/reduce.cpp
array c = sum(a, 1); // sum across the second dimension

// Create d by summing across the third dimension
array d = sum(a, 2); // sum across the third dimension
Copy link
Copy Markdown
Member

umar456 Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Not super useful for this shape of an array. It will just return the same value as the input.

Comment thread test/range.cpp Show resolved Hide resolved
umar456 merged commit 33935ab into arrayfire:master Jan 24, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

melonakos melonakos left review comments

umar456 umar456 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Footer

© 2026 GitHub, Inc.