Hi there,

My name is Yash Vardhan. I am a computer science student. I am applying for
Google Summer of Code (GSoC) 2026. I want to work on the libssh project. I
have downloaded the project code. Built it on my local machine using WSL2.
I have been going through the issues.

I ran a command `make docs` on my machine and looked at all the warnings
from Doxygen. There are 236 warnings in 34 files. I also checked a mr
(!774) to see what was done before and what feedback was given by Jakub.
This way I can avoid making the mistakes.

Here are my plans:

1. I want to fix Doxygen warnings in two files: `src/channels.c` and
`src/messages.c` (#342). These files do not have a contributor yet. Have
about 29 undocumented parts. I will follow the style guidelines from the MR
(!774). This means I will not put lines between @params I will put doc
blocks next to functions I will use named constants like `SSH_OK` and
`SSH_ERROR` instead of numbers and I will use the correct order for @param.

2. For issue #332 the previous MR (!774) did not address the part, about
checking for warnings. So I want to explore using a Doxygen flag called
`WARN_AS_ERROR` in the current documentation job. This would help prevent
warnings from being added. I want to check if this approach makes sense to
you before I create a merge request. I know you prefer to avoid using
custom bash scripts.

I look forward to your feedback.

Thanks,

Yash Vardhan

Reply via email to