search

loxsmoke / mddox

Markdown documentation generator tool
MIT License
37 stars 10 forks source link

Generate Method Details #15

Closed ferreus closed 4 years ago

ferreus commented 4 years ago

Added option -M / --method-details to generate method details.

i.e:

DisplayImage(Device device, string imagePath, byte brightness)

Writes image to device's framebuffer

Param Description
device Target device
imagePath Path to image file, image will be scaled to match device display resolution
brightness Set display brightness, 0 to turn display off

 

loxsmoke commented 4 years ago

For consistency constructors should be documented as well.

loxsmoke commented 4 years ago

I'll merge this request and do some changes.

ferreus commented 4 years ago

Hi, Could i bother you with something? The merged pull replace accidentally leaked my work email. Can you rewrite history and remove the mention of my work email and leave only my actual email? str3l0k@gmail.com.

loxsmoke commented 4 years ago

Never needed to overwrite git history before. If you could get me the list of commands to execute I could do it.

ferreus commented 4 years ago

But you should know it's dangerous. Since you will be overwriting the history of your last 3 commits, anyone who might have forked you repository in this time, might have problems when they will try to merge / pull from you again.

Anyway, the commands are as follows: git rebase -i HEAD~3

In the editor, change 'pick' to 'edit' on this line only: pick 0da568d Generate Method Details (#15) save and exit.

git commit --amend

change the commit message, remove the co-authored line (thanks)

git rebase --continue

And now you need to force this changes on github: git push -f

Thanks.

On Sun, Sep 27, 2020 at 4:39 AM LoxSmoke notifications@github.com wrote:

Never needed to overwrite git history before. If you could get me the list of commands to execute I could do it.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/loxsmoke/mddox/pull/15#issuecomment-699570902, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABSNLBISQJDO6JDWB7LWBTSH2JVDANCNFSM4QUTWN2Q .

-- If you can't explain it simply, you don't understand it well enough. - Albert Einstein

ferreus commented 4 years ago

I just checked, you have 5 forks on this repository, but none are recent. So it's kinda safe. Unless someone forks right now ;)

On Sun, Sep 27, 2020 at 4:56 AM Vladimir Vainer str3l0k@gmail.com wrote:

But you should know it's dangerous. Since you will be overwriting the history of your last 3 commits, anyone who might have forked you repository in this time, might have problems when they will try to merge / pull from you again.

Anyway, the commands are as follows: git rebase -i HEAD~3

In the editor, change 'pick' to 'edit' on this line only: pick 0da568d Generate Method Details (#15) save and exit.

git commit --amend

change the commit message, remove the co-authored line (thanks)

git rebase --continue

And now you need to force this changes on github: git push -f

Thanks.

On Sun, Sep 27, 2020 at 4:39 AM LoxSmoke notifications@github.com wrote:

Never needed to overwrite git history before. If you could get me the list of commands to execute I could do it.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/loxsmoke/mddox/pull/15#issuecomment-699570902, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABSNLBISQJDO6JDWB7LWBTSH2JVDANCNFSM4QUTWN2Q .

-- If you can't explain it simply, you don't understand it well enough. - Albert Einstein

-- If you can't explain it simply, you don't understand it well enough. - Albert Einstein