Are scaladocs comment useful?

[Bellaz89]

Hi all!

I plan to use SpinalHDL for my PhD work.

In the official documentation I found a lot of useful stuff but I see that a lot of things are not covered and have to be searched in the code.

Is there any usefulness in adding, for example, scaladocs comments? I can do this in my spare time for some components..

Anyway are there any contribution guidelines for SpinalHDL and related project?

Thank you for this wonderful project!

Regards

Andrea

[Charles Papon]

Hi,

Personnaly, i'm never using the HTML Scala docs, but i'm always using the intellij navigation utilities to look around. Anyways, i think that's right to say it lack comments.

I would say, comments saying basicaly the same than what the code express itself in a clear manner in the next 10 lines is counter productive.

I'm sorry, currently, there is no guidelines, i would just say to avoid over commenting things :D

Thanks :)

What is your PhD work ?

Charles

[Bellaz89]

Hi,

I'm working on particle accelerator control (..keyword LLRF..) for next generation superconducting linacs (https://www.xfel.eu/), so basically DSP stuff.

For our firmware we use VHDL on Xilinx FPGAs therefore I think that SpinalHDL is the best option for me to interface with the codebase we already have.Also I like very much FP.

Also I would like at a certain point to use VexRisc for some '''slow''' DSP calculations.

Regards

Andrea

[Bellaz89]

BTW .. did you write any scientific publication about SpinalHDL? Giving that I can convince my colleagues to use SpinalHDL I could try to cite it

Andrea

[Charles Papon]

No paper about SpinalHDL, but there a few blog about it in https://tomverbeure.github.io/ (VexRiscv, SpinalHDL)
Also, there is some video on youtube of some talks a did.