Interested in STEP Source Code Documentation under BRL-CAD [GSOC 2016]

[Manpreet Dhiman]

Hello,

My name is Manpreet Dhiman pursuing Master of Computer Applications at
Guru Nanak Dev Engineering College, Ludhiana.

I have worked on Python , C++ and Doxgen. I have a good command on
Doxygen for Python and C++ languages.

I found Doxygen related project in GSoc under BRL-CAD. I read your
project idea for STEP Source Code Documentation. You require advance
feature of Doxygen in your project. So, I am interested to do work on
STEP Source Code Documentation project. As it is based on Doxygen. And
I deal with Doxygen to create documentation of Python, C++  project. I
did this 6 month ago. Now I want to do work on doxygen with advance
features that is discussed in STEP Source Code Documentation.

Please tell me what are your other requirements and guide me for the same.

Thank you,

[Manpreet Dhiman]

On Tuesday, March 8, 2016 at 1:50:53 AM UTC+5:30, Manpreet Dhiman wrote:

Hello,

My name is Manpreet Dhiman pursuing Master of Computer Applications at
Guru Nanak Dev Engineering College, Ludhiana.

I have worked on Python , C++ and Doxgen. I have a good command on
Doxygen for Python and C++ languages.

<snip>

I am writing my proposal for STEPCode project "STEP Source Code Documentation" . I want to know more about this project. What are requirements of this project and How I can contribute in this?. So that I can make my proposal better.

Thank you.

Thank you,

[Christopher Sean Morrison]

On Mar 23, 2016, at 01:02 PM, Manpreet Dhiman <manpre...@gmail.com> wrote:

I am writing my proposal for STEPCode project "STEP Source Code Documentation" . I want to know more about this project. What are requirements of this project and How I can contribute in this?. So that I can make my proposal better.

It is your project proposal, so you are defining the requirements for what you'd like to accomplish.

This naturally requires you to do some work to understand what STEPcode is, the state of the documentation, the nature of building parsers with STEPcode, and to gain familiarity with the source code you would be modifying.  This is required so you have a solid understanding of what to modify and how long it might take you so you can write your proposal.

Don't think of this like homework or contract work.  We don't define the project or the objectives.  You get to do that! :)

Cheers,

Sean

[Manpreet Dhiman]

Thank you, for replying.

And thank you, for giving me detail about this project. I am really enthsiastic to contribute in this project. In case my proposal is not selected then I am really wish to contribute in this project.                                                                                                                                                                                                               

 cheer's

 

[Manpreet Dhiman]

I write proposal and define sequence of task that I  will accomplish during boding period. And now I am  understanding current code and Documentation. Normally, we can see Doxygen Documentation from .html file. But this project, used CMake with Doxygen for Documentation. So, I run doxygen using "make doc" command. But unable to see  documentation.How  I can see current  Documentation. Where I am wrong?. Guide me, so that I can write best proposal.

 

[Manpreet Dhiman]

On Thursday, March 24, 2016 at 12:25:22 AM UTC+5:30, Sean wrote:

What are other requirements of this project including Documentation?. Is there any work that you wish to add?.
 

[Manpreet Dhiman]

On Thursday, March 24, 2016 at 12:25:22 AM UTC+5:30, Sean wrote:

I draft my proposal for STEPcode project.Can you suggest something to make it better. Here is link: https://docs.google.com/document/d/1nR91Ew6I6GrAAtoDFeeRlplcjmTmIEmFhgSqYm4cNrg/edit

[Charlie Stirk]

You will need to submit a patch.   In your proposal you need to show that you successfully built STEPcode by including a page from the current Doxygen generated documentation.   Also, describe in your proposal what features the current STEPcode documentation possesses, and then specifically what you intend to improve.         

--
You received this message because you are subscribed to the Google Groups "STEPcode - Developers Mailing List" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scl-dev+u...@googlegroups.com.
To post to this group, send email to scl...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/scl-dev/e6e06a6e-73a0-4e2f-b692-4cf3c89dff1d%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

Charlie Stirk