drivers/periph/i2c: Replace LaTeX formula with static SVG file in documentation#21876
drivers/periph/i2c: Replace LaTeX formula with static SVG file in documentation#21876AnnsAnns merged 1 commit intoRIOT-OS:masterfrom
Conversation
8659618 to
bf3e118
Compare
AnnsAnns
left a comment
There was a problem hiding this comment.
RE: SVG problem
I've encountered that a few times during my bachelor thesis so far. The trick is to re-export the SVG using inkscape because SVG rendering is cursed weird.
|
Oops, did not want to approve with this but I guess the approval still counts once the SVG is fixed 😅 |
|
Why not just get rid of the math rendering and go for somethin code style this would make the formular readable in the comment (and not only in doxygen / html rendering) the latex-math is barely readable in the c-comment and the svg even less |
| * \f$ I_{OL} =\f$ Low level output current, | ||
| * \f$ t_r =\f$ Signal rise time, | ||
| * \f$ C_b =\f$ Bus capacitance <br> | ||
| * @image html periph_i2c_bus_equations.svg |
There was a problem hiding this comment.
KISS
| * @image html periph_i2c_bus_equations.svg | |
| * R_min = (V_DD - V_OL) / I_OL | |
| * R_max = t_r / (0.8473 * C_b) | |
| * Where: | |
| * V_DD: Supply voltage | |
| * V_OL: Low level voltage upper limit | |
| * I_OL: Low level output current, | |
| * t_r: Signal rise time, | |
| * C_b: Bus capacitance |
There was a problem hiding this comment.
I like the utilitarian approach, but the SVG image is more beautifuller :)
adba415 to
f790d71
Compare
|
Squashy squash pls |
f790d71 to
1cd37aa
Compare
|
Thank you for the review and the modified SVG :) |





Contribution description
I started adding the MathJax support as discussed in #21490 but then I realized that it is somewhat stupid to add such a big dependency for static LaTeX formulas and instead asked ChatGPT to generate SVG files from said LaTeX formulas.
Also I changed the comments from//to/* */to stay consistent with our Coding Convention.This breaks things when not inside a
doc.mdfile.Testing procedure
Check the generated Doxygen documentation in the subpage
group__drivers__periph__i2c.html.Issues/PRs references
Fixes #21490.
Depends on (and currently includes) #21372.