Skip to content

Update C# API Docs #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 9 commits into from
Jan 5, 2022
Merged

Update C# API Docs #42

merged 9 commits into from
Jan 5, 2022

Conversation

@taooceros
Copy link
Member

@taooceros taooceros commented Dec 29, 2021 •
edited
Loading

Update C# API Docs and add dispose information

@taooceros taooceros requested a review from jjw24 December 29, 2021 19:14
@taooceros taooceros changed the title add dispose docs Update C# API Docs Dec 29, 2021
@jjw24
Copy link
Member

jjw24 commented Dec 31, 2021

is there a dependency on this pr Flow-Launcher/Flow.Launcher#938 ?

@jjw24
Copy link
Member

jjw24 commented Dec 31, 2021

can you please provide a preview in your fork

@taooceros
Copy link
Member Author

is there a dependency on this pr Flow-Launcher/Flow.Launcher#938 ?

not really, it is generated locally. If we want to generate this automatically we need that.

@taooceros
Copy link
Member Author

https://taooceros.github.io/docs/#/API-Reference/

@taooceros
Copy link
Member Author

weird the reference somehow not working when i deployed it but works locally? so weird

@taooceros
Copy link
Member Author

oh it's because of windows file system is case ignore....I will fix it now

@jjw24
Copy link
Member

jjw24 commented Jan 2, 2022

hitting a lot of 404s, e.g. https://taooceros.github.io/docs/#/API-Reference/Flow.Launcher.Plugin/PluginInitContext

@jjw24
Copy link
Member

jjw24 commented Jan 2, 2022

also please update the branch to the latest

@taooceros
Copy link
Member Author

Fix the issue. I thought I fix the case insensitive issue but actually not. This time actually fix it.

@taooceros
Copy link
Member Author

still get some issue. let me check again

@taooceros
Copy link
Member Author

ok fix it

@jjw24
Copy link
Member

jjw24 commented Jan 3, 2022

these two namespaces have 404 Flow.Launcher.Plugin.SharedCommands + Flow.Launcher.Plugin.SharedModels namespace
https://taooceros.github.io/docs/#/API-Reference/Flow.Launcher.Plugin?id=flowlauncherpluginsharedcommands-namespace

@taooceros
Copy link
Member Author

these two namespaces have 404 Flow.Launcher.Plugin.SharedCommands + Flow.Launcher.Plugin.SharedModels namespace
https://taooceros.github.io/docs/#/API-Reference/Flow.Launcher.Plugin?id=flowlauncherpluginsharedcommands-namespace

What?? That hasn't been fixed? I will check again🤔

@taooceros
Copy link
Member Author

Oh it is fixed... I just forget to sync to my fork.

@jjw24
Copy link
Member

jjw24 commented Jan 5, 2022

how do i regenerate/update these files when need to?

@taooceros
Copy link
Member Author

taooceros commented Jan 5, 2022 •
edited
Loading

how do i regenerate/update these files when need to?

https://ejball.com/XmlDocMarkdown/

It's easy to use. Just create a console project reference back to the Flow.Launcher.Plugin project, and follow the instruction to generate the document. Probably we can even make it generate it automatically.

@jjw24
Copy link
Member

jjw24 commented Jan 5, 2022

Yeah that's what I am thinking, set up a workflow for it

@jjw24 jjw24 merged commit 03d77d1 into main Jan 5, 2022
@jjw24 jjw24 deleted the CSharpPluginDoc branch January 5, 2022 23:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jjw24 jjw24 jjw24 approved these changes

Assignees

@taooceros taooceros

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@taooceros @jjw24