Someone seems to have posted nvda dev docs online. They are a bit old,
2020.3, but it is the best we have. I looked at some modules and they seem
ok, but I can't guarantee their overall correctness
https://nvda.es/wp-content/uploads/nvda_2020.3_devDocs.zip
-----Original Message-----
From: Joseph Lee
Sent: Tuesday, March 9, 2021 7:26 PM
To: program-l@xxxxxxxxxxxxx
Subject: [program-l] Re: Getting a panoramic view of code
Hi,
I tend to use Grep for looking up function definitions and such (I use WSL
for NVDA source code management). Even before that, I read source code docs
(at least starting with what's available in public) to understand the
overall structure and read parts of source code that interests me and expand
from there.
Regarding NvDA source code, I know that new contributors and add-on writers
are having difficulty understanding it fully. Part of this stems from lack
of publicly viewable source code documentation that's easily discoverable.
You can use Sphinx to build NVDA docs locally now, but I'm coordinating an
effort to make the source code docs easily discoverable online (if given a
chance, I hope to discuss this later during the planned Zoom call, whenever
it might be).
Cheers,
Joseph
-----Original Message-----
From: program-l-bounce@xxxxxxxxxxxxx <program-l-bounce@xxxxxxxxxxxxx> On
Behalf Of Stefan Moisei
Sent: Tuesday, March 9, 2021 8:59 AM
To: program-l@xxxxxxxxxxxxx
Subject: [program-l] Re: Getting a panoramic view of code
For python in any text editor, you could use indentnav. It is an nvda addon
which makes indentation look like a tree view. The only place it doesn't
work is vs code, and the author has written an vs code extension with the
same functions.
I'd also appreciate the option to go to function definitions in other files.
For nvda development, I heard this is possible with vs code, but hadn't had
time to try the setup yet.
For my regular work in c#, visual studio gives me both functions.
-----Original Message-----
From: Alberto Buffolino
Sent: Tuesday, March 9, 2021 1:59 PM
To: program-l
Subject: [program-l] Getting a panoramic view of code
Hi all,
about recent discussions here, I'm thinking again around a problem I have
always had in last 10 years, when I started my Computer Science degree
course, and then code contributions (mostly for NVDA).
How to get a panoramic idea of current sourcecode?
I have used Eclipse, and appreciated its treeview with
packages/classes/methods; I love Notepad++, but its Function List feature is
quite unconfortable (UPDATE: tested again in this moment,
Notepad++ 7.9.1, it seems perfect now! 😍); I know UML existence, and
maybe PlantUML could help sometime...
In conclusion: do you have experience to share for this goal?
It would be useful for a lot of people here, I think 🙂
Alberto
** To leave the list, click on the immediately-following link:-
** [mailto:program-l-request@xxxxxxxxxxxxx?subject=unsubscribe]
** If this link doesn't work then send a message to:
** program-l-request@xxxxxxxxxxxxx
** and in the Subject line type
** unsubscribe
** For other list commands such as vacation mode, click on the
** immediately-following link:-
** [mailto:program-l-request@xxxxxxxxxxxxx?subject=faq]
** or send a message, to
** program-l-request@xxxxxxxxxxxxx with the Subject:- faq
** To leave the list, click on the immediately-following link:-
** [mailto:program-l-request@xxxxxxxxxxxxx?subject=unsubscribe]
** If this link doesn't work then send a message to:
** program-l-request@xxxxxxxxxxxxx
** and in the Subject line type
** unsubscribe
** For other list commands such as vacation mode, click on the
** immediately-following link:-
** [mailto:program-l-request@xxxxxxxxxxxxx?subject=faq]
** or send a message, to
** program-l-request@xxxxxxxxxxxxx with the Subject:- faq
** To leave the list, click on the immediately-following link:-
** [mailto:program-l-request@xxxxxxxxxxxxx?subject=unsubscribe]
** If this link doesn't work then send a message to:
** program-l-request@xxxxxxxxxxxxx
** and in the Subject line type
** unsubscribe
** For other list commands such as vacation mode, click on the
** immediately-following link:-
** [mailto:program-l-request@xxxxxxxxxxxxx?subject=faq]
** or send a message, to
** program-l-request@xxxxxxxxxxxxx with the Subject:- faq
** To leave the list, click on the immediately-following link:-
** [mailto:program-l-request@xxxxxxxxxxxxx?subject=unsubscribe]
** If this link doesn't work then send a message to:
** program-l-request@xxxxxxxxxxxxx
** and in the Subject line type
** unsubscribe
** For other list commands such as vacation mode, click on the
** immediately-following link:-
** [mailto:program-l-request@xxxxxxxxxxxxx?subject=faq]
** or send a message, to
** program-l-request@xxxxxxxxxxxxx with the Subject:- faq
