Skip to content

Commit

Permalink
Fix whitespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
seanbudd committed Aug 1, 2024
1 parent be112ed commit f227ca6
Show file tree
Hide file tree
Showing 94 changed files with 538 additions and 548 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ about: Create a report to help us improve
Please thoroughly read NVDA's wiki article on how to fill in this template, including how to provide the required files.
Issues may be closed if the required information is not present.
https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/githubIssueTemplateExplanationAndExamples.md
Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests.
Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests.
Each of the questions and sections below start with multiple hash symbols (#). Place your answers and information on the blank line below each question.
-->
Expand All @@ -17,14 +17,14 @@ Each of the questions and sections below start with multiple hash symbols (#). P

### Actual behavior:
<!--
Use "Speak command keys" (NVDA+4) and speech viewer to copy and paste here.
Use "Speak command keys" (NVDA+4) and speech viewer to copy and paste here.
Use braille viewer to copy and paste here.
You may additionally include an explanation.
-->

### Expected behavior:
<!--
Use "Speak command keys" (NVDA+4) and speech viewer to copy and paste here.
Use "Speak command keys" (NVDA+4) and speech viewer to copy and paste here.
Use braille viewer to copy and paste here.
You may additionally include an explanation.
-->
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ about: Suggest an idea for this project
Please thoroughly read NVDA's wiki article on how to fill in this template, including how to provide the required files.
Issues may be closed if the required information is not present.
https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/githubIssueTemplateExplanationAndExamples.md
Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests.
Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests.
Each of the questions and sections below start with multiple hash symbols (#). Place your answers and information on the blank line below each question.
-->
Expand Down
11 changes: 5 additions & 6 deletions .github/ISSUE_TEMPLATE/special_case_issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ about: A complex or exceptional issue that doesn't fit into the usual templates
---

<!--
Please read the text in this edit field before filling it in.
Please read the text in this edit field before filling it in.
For guidance on how to fill in this template, including how to provide the required files, please see:
https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/githubIssueTemplateExplanationAndExamples.md
If your issue doesn't neatly fit into either the bug report or feature request categories, and it involves a more complex or unique scenario, use this template.
If your issue doesn't neatly fit into either the bug report or feature request categories, and it involves a more complex or unique scenario, use this template.
Before proceeding, please review the existing templates to ensure that those do not better suit your needs:
- Bug Report Template: https://github.com/nvaccess/nvda/issues/new?template=bug_report.md
- Feature Request Template: https://github.com/nvaccess/nvda/issues/new?template=feature_request.md
If the required information is not provided upon request, the issue may be closed.
Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md.
NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project.
Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md.
NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project.
This includes creating or commenting on issues and pull requests.
Questions below start with multiple hash symbols (#).
Questions below start with multiple hash symbols (#).
Please place your answers and information on the blank line below each question.
-->

Expand All @@ -47,4 +47,3 @@ Please place your answers and information on the blank line below each question.


### Additional information (if applicable)

6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!-- Please read and fill in the following template, for an explanation of the sections see:
https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/githubPullRequestTemplateExplanationAndExamples.md
Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests.
Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests.
Please initially open PRs as a draft.
When you would like a review, mark the PR as "ready for review".
When you would like a review, mark the PR as "ready for review".
See https://github.com/nvaccess/nvda/blob/master/.github/CONTRIBUTING.md.
-->

Expand Down Expand Up @@ -42,7 +42,7 @@ https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/githubPullRequestTe
- System (end to end) tests
- Manual testing
- [ ] UX of all users considered:
- Speech
- Speech
- Braille
- Low Vision
- Different web browsers
Expand Down
14 changes: 7 additions & 7 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
## 1. Purpose
A primary goal of NV Access and NVDA is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, nationality, socioeconomic status, education, level of experience and religion (or lack thereof).
This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behaviour.
We invite all those who participate in the NVDA community to help us create safe and positive experiences for everyone. NVDA is a user driven initiative.
We invite all those who participate in the NVDA community to help us create safe and positive experiences for everyone. NVDA is a user driven initiative.

## 2. Open Source Citizenship
A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognise and strengthen the relationships between our actions and their effects on our community.
A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognise and strengthen the relationships between our actions and their effects on our community.
Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.

Expand Down Expand Up @@ -45,21 +45,21 @@ If a community member engages in unacceptable behaviour, NV Access Staff may tak
NV Access Staff have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful.

## 6. Reporting Guidelines
If you are subject to or witness unacceptable behaviour, or have any other concerns, please notify NV Access staff as soon as possible via [email protected]. The information required for notifications includes PR/Issue Number, nature of breach, community member responsible, date and time of breach. Please note that the details of the reporter will not be disclosed, unless required to by law.
If you are subject to or witness unacceptable behaviour, or have any other concerns, please notify NV Access staff as soon as possible via [email protected]. The information required for notifications includes PR/Issue Number, nature of breach, community member responsible, date and time of breach. Please note that the details of the reporter will not be disclosed, unless required to by law.

## 7. Addressing Grievances
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify NV Access at [email protected] with a concise description of your grievance.
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify NV Access at [email protected] with a concise description of your grievance.

## 8. Scope
We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business.
This code of conduct and its related procedures also applies to unacceptable behaviour occurring outside the scope of community activities when such behaviour has the potential to adversely affect the safety and well-being of community members.
For others setting up or running an NVDA group of any kind, it is strongly recommended that a complementary Citizen and Contributor Code of Conduct is adopted.
This code of conduct and its related procedures also applies to unacceptable behaviour occurring outside the scope of community activities when such behaviour has the potential to adversely affect the safety and well-being of community members.
For others setting up or running an NVDA group of any kind, it is strongly recommended that a complementary Citizen and Contributor Code of Conduct is adopted.

## 9. Contact info
[email protected]

## 10. License and attribution
The Citizen and Contributor Code of Conduct is distributed by NV Access Limited.
The Citizen and Contributor Code of Conduct is distributed by NV Access Limited.
Portions of text were derived from the GitHub sample Citizen and Contributor Code of Conduct, which is distributed under a Creative Commons Attribution-ShareAlike license.

Revision history:
Expand Down
10 changes: 5 additions & 5 deletions appveyor/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
`appveyor.yml` specifies build settings which generally [override online UI driven settings](https://www.appveyor.com/docs/build-configuration/#appveyoryml-and-ui-coexistence).
`appveyor.yml` specifies build settings which generally [override online UI driven settings](https://www.appveyor.com/docs/build-configuration/#appveyoryml-and-ui-coexistence).

# Branch and tag filtering

Expand All @@ -12,7 +12,7 @@ Builds will fail if any command has a non-zero exit code. PowerShell scripts con

## Setup process

Before we begin the install process, AppVeyor clones our repository and checks out the commit of the build.
Before we begin the install process, AppVeyor clones our repository and checks out the commit of the build.

### `install`

Expand All @@ -31,7 +31,7 @@ Performs a build of NVDA and related artifacts for testing and deployment.

## Testing

Unlike the rest of the build, tests do not exit early if they fail or raise an error. If any test fails, `testFailExitCode` is set to 1. The `after_test` build phase will exit the build if any tests fail so that all test failures can be recorded where possible.
Unlike the rest of the build, tests do not exit early if they fail or raise an error. If any test fails, `testFailExitCode` is set to 1. The `after_test` build phase will exit the build if any tests fail so that all test failures can be recorded where possible.

Before testing we:

Expand All @@ -48,9 +48,9 @@ The tests we perform are:

## Artifacts

Artifacts are added to the build throughout the process.
Artifacts are added to the build throughout the process.

Artifacts in `output\*` and `output\*\*` are automatically packaged after successful tests. If something fails before then, we manually push these artifacts in `on_failure`. Artifacts outside of `output` are pushed manually as they are created.
Artifacts in `output\*` and `output\*\*` are automatically packaged after successful tests. If something fails before then, we manually push these artifacts in `on_failure`. Artifacts outside of `output` are pushed manually as they are created.

At the end of the build, regardless of failure, we upload the list of successfully installed python packages in `pushPackagingInfo.ps1`. This is performed here in case scons (partially) fails.

Expand Down
2 changes: 1 addition & 1 deletion include/espeak.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ If the last thing is compiling some dictionary try excluding it.
This can be done in [`nvdaHelper/espeak/sconscript`](../nvdaHelper/espeak/sconscript).
Remember to report this to the eSpeak-ng project.
If the build fails, take note of the error, compare the diff of the `Makefile.am` file and mirror
If the build fails, take note of the error, compare the diff of the `Makefile.am` file and mirror
any changes in our `sconscript` file.
### Known issues
Expand Down
4 changes: 2 additions & 2 deletions nvdaHelper/common/PerfTimer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@ std::string PerfTimer::GetPerfResults() {
std::stringstream sstream;
sstream << "Perf Results\n";
for(auto& result : perfResults){
sstream << result.first << " Total time: " << result.second.totalTime
sstream << result.first << " Total time: " << result.second.totalTime
<< " Hit count: " << result.second.numberOfHits;
if(result.second.totalTime > 0 && result.second.numberOfHits > 0) {
sstream << " Average Time: " << result.second.totalTime / result.second.numberOfHits;
}
sstream << '\n';
}
return sstream.str();
}
}
2 changes: 1 addition & 1 deletion nvdaHelper/common/PerfTimer.h
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ class PerfTimer {
static std::map<std::string, PerfResult> s_results; ///< The results being collected.
};

#endif
#endif
4 changes: 2 additions & 2 deletions nvdaHelper/common/apiHook.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This license can be found at:

#include <iostream>
#include <set>
#define WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#include <delayimp.h>
#include <detours/src/detours.h>
Expand Down Expand Up @@ -66,7 +66,7 @@ bool apiHook_commitTransaction() {
if (res != NO_ERROR) {
LOG_ERROR("DetourTransactionCommit failed with " << res << " due to variable at address 0X" << std::hex << failedPointerRef << " that should hold a function pointer");
return false;
}
}
LOG_DEBUG("DetourTransactionCommit succeeded");
return TRUE;
}
Expand Down
8 changes: 4 additions & 4 deletions nvdaHelper/common/apiHook.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ This license can be found at:
/**
* Initializes an API hooking transaction.
* @return success flag
*/
*/
bool apiHook_beginTransaction();

/**
* Requests that the given function from the given module should be hooked with the given hook procedure.
* Requests that the given function from the given module should be hooked with the given hook procedure.
* Warning, this function has no safety checks, you should usually use the apiHook_hookFunction_safe template
* @param realFunction the function you wish to hook.
* @param fakeFunction the function you wish to be called instead of the original one.
* @param targetPointerRef Pointer variable that will contain a pointer to the original function after hooking. This is used to unhook.
*/
*/
bool apiHook_hookFunction(void* realFunction, void* fakeFunction, void** targetPointerRef);

/**
Expand All @@ -36,7 +36,7 @@ bool apiHook_hookFunction(void* realFunction, void* fakeFunction, void** targetP
* @param realFunction the function you wish to hook.
* @param fakeFunction the function you wish to be called instead of the original one.
* @param targetPointerRef Pointer variable that will contain a pointer to the original function after hooking. This is used to unhook.
*/
*/
template<typename funcType>
bool apiHook_hookFunction_safe(funcType realFunction, funcType fakeFunction, funcType* targetPointerRef) {
return apiHook_hookFunction(
Expand Down
3 changes: 1 addition & 2 deletions nvdaHelper/common/libraryLoader.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This license can be found at:

// A Smart Library handle.
// Construct it with a handle returned by LoadLibrary or similar.
// Once the object goes out of scope, FreeLibrary will automatically be called on the handle.
// Once the object goes out of scope, FreeLibrary will automatically be called on the handle.
class CLoadedLibrary {
private:
HMODULE _hModule {nullptr};
Expand Down Expand Up @@ -54,4 +54,3 @@ class CLoadedLibrary {
}

};

2 changes: 1 addition & 1 deletion nvdaHelper/common/lock.h
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,4 @@ long incRef() {

};

#endif
#endif
2 changes: 1 addition & 1 deletion nvdaHelper/common/winIPCUtils.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This license can be found at:
#include <cwchar>
#include <string>
#include <sstream>
#define WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#include "winIPCUtils.h"

Expand Down
3 changes: 1 addition & 2 deletions nvdaHelper/common/winIPCUtils.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This license can be found at:
#ifdef __cplusplus
extern "C" {
#endif

#include <wchar.h>

/**
Expand All @@ -33,4 +33,3 @@ size_t generateDesktopSpecificNamespace(wchar_t* buf, size_t cch);
#endif

#endif

4 changes: 2 additions & 2 deletions nvdaHelper/local/UIAEventLimiter/api.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ std::set<RateLimitedEventHandler*> activeRateLimitedEventHandlers;
HRESULT rateLimitedUIAEventHandler_create(IUnknown* pExistingHandler, RateLimitedEventHandler** ppRateLimitedEventHandler) {
LOG_DEBUG(L"rateLimitedUIAEventHandler_create called");
if(!pExistingHandler || !ppRateLimitedEventHandler) {
LOG_ERROR(L"rateLimitedUIAEventHandler_create: one or more NULL arguments");
LOG_ERROR(L"rateLimitedUIAEventHandler_create: one or more NULL arguments");
return E_INVALIDARG;
}

Expand All @@ -39,7 +39,7 @@ HRESULT rateLimitedUIAEventHandler_create(IUnknown* pExistingHandler, RateLimite

// @brief Terminates a RateLimitedEventHandler instance's flusher thread and removes it from the activeRateLimitedEventHandlers set.
// @param pRateLimitedEventHandler the RateLimitedEventHandler instance to terminate.
// @note This function will block until the RateLimitedEventHandler's flusher thread has terminated.
// @note This function will block until the RateLimitedEventHandler's flusher thread has terminated.
// @return S_OK on success or a failure code otherwise
HRESULT rateLimitedUIAEventHandler_terminate(RateLimitedEventHandler* pRateLimitedEventHandler) {
if (activeRateLimitedEventHandlers.find(pRateLimitedEventHandler) == activeRateLimitedEventHandlers.end()) {
Expand Down
Loading

0 comments on commit f227ca6

Please sign in to comment.