JuliaImages / ImageFeatures.jl

Image feature detection for the Julia language
Other
44 stars 28 forks source link

docstring missing #61

Open johnnychen94 opened 5 years ago

johnnychen94 commented 5 years ago

The current julia documentation fails to build: https://github.com/JuliaImages/juliaimages.github.io/issues/44#issuecomment-453773548

When building Images.jl Documentation https://github.com/JuliaImages/juliaimages.github.io with Documenter v0.22, there'll be lots of unresolved links if using @docs macro in function_reference.md

```@docs
glcm
...
``` #

and glcm doesn't have its docstring

help?> glcm
search: glcm glcm_prop glcm_norm glcm_var_ref glcm_entropy glcm_mean_ref glcm_symmetric glcm_var_neighbour

  No documentation found.

To supprese the no-doc-found warnings, I temporarily changed @docs to julia in https://github.com/JuliaImages/juliaimages.github.io/pull/50

The following is a list of undocumented methods

cc: @timholy

Jay-sanjay commented 11 months ago

is the issue resolved sir

ashwani-rathee commented 11 months ago

It's not actually, as you might notice here: https://github.com/JuliaImages/ImageFeatures.jl/blob/master/src/brisk.jl all those functions are documented and we could use help :)

Jay-sanjay commented 10 months ago

Sir starting with first function glcm and the related glcm functions just needed to confirm https://github.com/JuliaImages/ImageFeatures.jl/blob/master/docs/src/tutorials/glcm.md?plain=1#L1-L26 I have to make changes in these .md files am I right ?