Rust doc: add docstring to rust module files - v1

[0xEniola]

Link to redmine ticket: https://redmine.openinfosecfoundation.org/issues/4584

Describe changes:

• Added docstrings for the short descriptions of Rust module files.

[github-actions]

NOTE: This PR may contain new authors:

Daniel Olatunji <danielolatunji20@outlook.com>

[jufajardini]

nit: our commit messages aren't usually started with capital letter, can you please use something like rust/doc?

For the mod file, could you please add something that indicates that? Eg. Template Application layer module, with the necessary rewordings, of course :P

There are lots of CI failures, but the ones I checked seemed connected to an inline comment I've left, so I'd suggest addressing that and seeing if things improve. :)

[jufajardini]

cargo clippy isn't happy with this doc comment (cf error[E0753]: expected outer doc comment). I'm not sure why, but I'm wondering if that's because we have a previous comment before.

I would suggest either removing this, as this module has a description, already, or moving this doc comment to before the file and author comment...

[0xEniola]

nit: our commit messages aren't usually started with capital letter, can you please use something like rust/doc?

For the mod file, could you please add something that indicates that? Eg. Template Application layer module, with the necessary rewordings, of course :P

There are lots of CI failures, but the ones I checked seemed connected to an inline comment I've left, so I'd suggest addressing that and seeing if things improve. :)

OK, you mean for each mod file, to indicate that it is a mod file, yeah?

[0xEniola]

nit: our commit messages aren't usually started with capital letter, can you please use something like rust/doc?

For the mod file, could you please add something that indicates that? Eg. Template Application layer module, with the necessary rewordings, of course :P

There are lots of CI failures, but the ones I checked seemed connected to an inline comment I've left, so I'd suggest addressing that and seeing if things improve. :)

You mean something like; FTP Application layer parser and logger module?

Like this?

[jufajardini]

nit: our commit messages aren't usually started with capital letter, can you please use something like rust/doc?
For the mod file, could you please add something that indicates that? Eg. Template Application layer module, with the necessary rewordings, of course :P
There are lots of CI failures, but the ones I checked seemed connected to an inline comment I've left, so I'd suggest addressing that and seeing if things improve. :)

OK, you mean for each mod file, to indicate that it is a mod file, yeah?

Yes, basically :)

[jufajardini]

nit: our commit messages aren't usually started with capital letter, can you please use something like rust/doc?
For the mod file, could you please add something that indicates that? Eg. Template Application layer module, with the necessary rewordings, of course :P
There are lots of CI failures, but the ones I checked seemed connected to an inline comment I've left, so I'd suggest addressing that and seeing if things improve. :)

You mean something like; FTP Application layer parser and logger module?

Like this?

Yup, looks better to me :)