search

scinfu / SwiftSoup

SwiftSoup: Pure Swift HTML Parser, with best of DOM, CSS, and jquery (Supports Linux, iOS, Mac, tvOS, watchOS)
https://scinfu.github.io/SwiftSoup/
MIT License
4.52k stars 345 forks source link

documentation #202

Closed dragonsKnight5 closed 2 years ago

dragonsKnight5 commented 2 years ago

Any chance of generating official documentation for SwiftSoup?

When I search for it in google I come across this link which appears to be broken, I'm not sure about how to generate it myself since all examples detailing this process that I've come across so far involve xcode and macOS whereas I'm using Linux(Fedora)

Best Regards dragonsKnight5

scinfu commented 2 years ago

Hi @dragonsKnight5 , The link you reported is not mine, they are links that external sites generate based on the README. For SwiftSoup documentation refer to the readme where the main functions of the library are documented. If you need more examples you can see unit test functions https://github.com/scinfu/SwiftSoup/tree/master/Tests/SwiftSoupTests

dragonsKnight5 commented 2 years ago

I know the link isn't yours, I was only mentioning it as a rough supporting reference.

I was hoping there might be documentation provided in a similar format to javadoc for java, I didn't realize that you were providing it in the root level readme file.

Thank you for clearing that up