search

cisco / libsrtp

Library for SRTP (Secure Realtime Transport Protocol)
Other
1.23k stars 476 forks source link

libstrp manual #228

Closed carlh54 closed 7 years ago

carlh54 commented 7 years ago

In the current version (2.0) the pdf reference manual was deleted from the release with the reason being that it was out of date. I just read the manual from a previous release and I am wondering which of the information is incorrect.

Is there somewhere where I can up to date information...or do I have to just read the source?

I noticed later that I can generate reference docs which I tried to do. I get this error that I can't resolve (not familiar with text generation tools):

(/usr/share/texlive/texmf-dist/tex/latex/psnfss/ot1pcr.fd) [1{/var/lib/texmf/fonts/map/pdftex/updmap /pdftex.map}] ! Undefined control sequence. l.82 \clearemptydoublepage

Appreciate any help.

/carl

thisisG commented 7 years ago

Hey! Yes the docs are fairly broken as it stands right now. I made a quick attempt at fixing the LaTeX generator but after resolving the missing \clearemptydoublepage I hit another error that I was unable to resolve. You are most likely better off reading the code for now as this contains the most up to date info available. I'll see if I can make a patch to get html docs generated instead!

carlh54 commented 7 years ago

thanks

On Tue, Jan 24, 2017 at 2:26 AM, Geir Istad notifications@github.com wrote:

Hey! Yes the docs are fairly broken as it stands right now. I made a quick attempt at fixing the LaTeX generator but after resolving the missing \clearemptydoublepage I hit another error that I was unable to resolve. You are most likely better off reading the code for now as this contains the most up to date info available. I'll see if I can make a patch to get html docs generated instead!

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/cisco/libsrtp/issues/228#issuecomment-274728938, or mute the thread https://github.com/notifications/unsubscribe-auth/AX_TLPAVxsy3Tvy8K-wqha--5bJJowhjks5rVaeMgaJpZM4LksFN .

pabuhler commented 7 years ago

Most of the documentation has been merged in to the README.md file. There is now also generated html documentation, include API documentation in the doc/html folder . Keep the documentation uptodate will be an ongoing process but this was good start considering where it was.