Skip to content

Added all *.cpp samples reference to the documentation#1206

Merged
opencv-pushbot merged 1 commit intoopencv:2.4from
StevenPuttemans:feature_3169
Jul 31, 2013
Merged

Added all *.cpp samples reference to the documentation#1206
opencv-pushbot merged 1 commit intoopencv:2.4from
StevenPuttemans:feature_3169

Conversation

@StevenPuttemans
Copy link
Copy Markdown

Added a link in documentation pointing to samples containing the functionality.
Did it only for the samples that have functionality in the 2.4 branch.

Suggestion was made in this feature request:
http://code.opencv.org/issues/3169

If this works out and gets merged, will consider doing same for other sample folders also.
Also want to know if it is usefull to add C samples, since we want to demotivate people using the interface?

@apavlenko
Copy link
Copy Markdown
Contributor

@StevenPuttemans please fix whitespace problems

@StevenPuttemans
Copy link
Copy Markdown
Author

@apavlenko will do so later today 👍

@ghost ghost assigned apavlenko Jul 30, 2013
@apavlenko
Copy link
Copy Markdown
Contributor

Steven, you did a great job! Thanks!
I wouldn't do such a reference for C samples.

@StevenPuttemans
Copy link
Copy Markdown
Author

Pushed the fix!

@StevenPuttemans
Copy link
Copy Markdown
Author

It seems still some whitespace were left :) must have missed two. Fixed!

@apavlenko it seems that there are 20 warnings about a label matrixexpressions being missing.

/home/user/slave/builds/precommit_docs/src/opencv/modules/core/doc/basic_structures.rst:274: WARNING: undefined label: matrixexpressions (if the link has no caption the label must precede a section header)

Should I remove them? Because I have no idea to what it should point or how I can add a fix for this!

EDIT: looking deeper into the problem, it seems that the doc can work with matrixexpressions, but it should in fact be matrix-expressions I am guessing. Will look into docs for it.

@StevenPuttemans
Copy link
Copy Markdown
Author

I guess it was my own fault, by adding a sample tag behind the link. We will see if moving it one up will have fixed the linking.

@apavlenko
Copy link
Copy Markdown
Contributor

It would also better if you use linux style slashes, they work on most OSes

@StevenPuttemans
Copy link
Copy Markdown
Author

Can you give an example of what you mean by that?

@apavlenko
Copy link
Copy Markdown
Contributor

opencv_source_code/samples/cpp/3calibration.cpp

@StevenPuttemans
Copy link
Copy Markdown
Author

ok but I havent defined it as link, so it wont be clickable? Is it worth adapting all the files then?

@apavlenko
Copy link
Copy Markdown
Contributor

universal slashes allow copy-paste path to console or so...

@StevenPuttemans
Copy link
Copy Markdown
Author

Hmm guess you have a point there :) Will update them today.

…ssed in feature #3169

- Used lunix style slashes - works on most systems
- Removed all trailing whitespaces
@StevenPuttemans
Copy link
Copy Markdown
Author

@apavlenko

Added linux style slashes. Considered it is also usefull to not create errors, since it is also used as escape character in LaTeX styled documents besides easy copying to systems.

Merged all commits into single usefull one.

@apavlenko
Copy link
Copy Markdown
Contributor

👍

@opencv-pushbot opencv-pushbot merged commit 0c52441 into opencv:2.4 Jul 31, 2013
@StevenPuttemans
Copy link
Copy Markdown
Author

👍

@StevenPuttemans StevenPuttemans deleted the feature_3169 branch July 31, 2013 10:33
@SpecLad SpecLad mentioned this pull request Aug 6, 2013
@apavlenko
Copy link
Copy Markdown
Contributor

@StevenPuttemans Steven, I've just noticed that you used some unknown ReST directive: Sample code that results in not displaying the sample references you contributed. I suggest you change it to a regular note (see below) and submit a separate PR:

.. note::

   * A calibration sample for 3 cameras in horizontal position can be found at 'opencv_source_code/samples/cpp/3calibration.cpp'
   * A calibration sample based on a sequence of images can be found at 'opencv_source_code/samples/cpp/calibration.cpp'

@StevenPuttemans
Copy link
Copy Markdown
Author

👍 hehe too bad :) I was expecting it to except every kind of form you want. Will do it later today probably.

@apavlenko
Copy link
Copy Markdown
Contributor

It's ReST format, see http://sphinx-doc.org/rest.html 'Directives' section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants