how to collect and document all private member variables of classes from large cpp code base? [closed]

up vote
0
down vote

favorite

I have a large cpp code base to work with. There are several dozens of class header files. All these files have private member variables usually a vector/pair/lists of other classes. I don't have useful documentation either (duh!). To reason with this unfamiliar code base I need to have a list of all the classes and their private data members alone. I want to ignore all the member functions as of now as they are simply manipulating the data structures of private variables.I don't want to run some code documentation tool and generate bunch of html pages.

Is there a way to pull out just these private member variables and build a simple table.
eg:

| MyRoad.h | Bus.h | Van.h | People.h |
|-------------+--------------+--------------+-------------|
| vector<Bus> | list<People> | list<People> | String name |
| vector<Van> | | | String age |

asked Nov 8 at 15:09

ticktock

44559

closed as off-topic by Some programmer dude, Galik, genpfault, SRack, user6910411 Nov 8 at 20:52

This question appears to be off-topic. The users who voted to close gave this specific reason:

"Questions asking us to recommend or find a book, tool, software library, tutorial or other off-site resource are off-topic for Stack Overflow as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it." – Some programmer dude, Galik, genpfault, user6910411

If this question can be reworded to fit the rules in the help center, please edit the question.

2

"I don't want to run some code documentation tool and generate bunch of html pages" - Other than "code documentation tools" I can't think of anything that would document your code for you tbh. The output of such tools is likely easy(ish) to parse and tabulate.
– Galik
Nov 8 at 15:15

@Galik okay, we can go code-doc tool route too, no problem. I just wanted something with less noise and precise. I want to ignore as much as possible and just focus on these private variables.
– ticktock
Nov 8 at 15:19

1

Aparently Doxygen has an XML output format that may be easier to parse: doxygen.org/manual/output.html
– Galik
Nov 8 at 15:20

1

Also you could maybe use clang to dump out the AST and parse that. stackoverflow.com/questions/18560019/how-to-view-clang-ast
– Galik
Nov 8 at 15:26

1

With doxygen don't forget to set EXTRACT_PRIVATE, also look at the WARN... settings.
– albert
Nov 8 at 16:18

add a comment |

up vote
0
down vote

favorite

Is there a way to pull out just these private member variables and build a simple table.
eg:

| MyRoad.h | Bus.h | Van.h | People.h |
|-------------+--------------+--------------+-------------|
| vector<Bus> | list<People> | list<People> | String name |
| vector<Van> | | | String age |

asked Nov 8 at 15:09

ticktock

44559

closed as off-topic by Some programmer dude, Galik, genpfault, SRack, user6910411 Nov 8 at 20:52

This question appears to be off-topic. The users who voted to close gave this specific reason:

"Questions asking us to recommend or find a book, tool, software library, tutorial or other off-site resource are off-topic for Stack Overflow as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it." – Some programmer dude, Galik, genpfault, user6910411

If this question can be reworded to fit the rules in the help center, please edit the question.

2

"I don't want to run some code documentation tool and generate bunch of html pages" - Other than "code documentation tools" I can't think of anything that would document your code for you tbh. The output of such tools is likely easy(ish) to parse and tabulate.
– Galik
Nov 8 at 15:15

@Galik okay, we can go code-doc tool route too, no problem. I just wanted something with less noise and precise. I want to ignore as much as possible and just focus on these private variables.
– ticktock
Nov 8 at 15:19

1

Aparently Doxygen has an XML output format that may be easier to parse: doxygen.org/manual/output.html
– Galik
Nov 8 at 15:20

1

Also you could maybe use clang to dump out the AST and parse that. stackoverflow.com/questions/18560019/how-to-view-clang-ast
– Galik
Nov 8 at 15:26

1

With doxygen don't forget to set EXTRACT_PRIVATE, also look at the WARN... settings.
– albert
Nov 8 at 16:18

add a comment |

up vote
0
down vote

favorite

Is there a way to pull out just these private member variables and build a simple table.
eg:

| MyRoad.h | Bus.h | Van.h | People.h |
|-------------+--------------+--------------+-------------|
| vector<Bus> | list<People> | list<People> | String name |
| vector<Van> | | | String age |

asked Nov 8 at 15:09

ticktock

44559

Is there a way to pull out just these private member variables and build a simple table.
eg:

| MyRoad.h | Bus.h | Van.h | People.h |
|-------------+--------------+--------------+-------------|
| vector<Bus> | list<People> | list<People> | String name |
| vector<Van> | | | String age |

c++ documentation

asked Nov 8 at 15:09

ticktock

44559

asked Nov 8 at 15:09

ticktock

44559

asked Nov 8 at 15:09

ticktock

44559

asked Nov 8 at 15:09

ticktock

44559

asked Nov 8 at 15:09

ticktock

44559

closed as off-topic by Some programmer dude, Galik, genpfault, SRack, user6910411 Nov 8 at 20:52

This question appears to be off-topic. The users who voted to close gave this specific reason:

"Questions asking us to recommend or find a book, tool, software library, tutorial or other off-site resource are off-topic for Stack Overflow as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it." – Some programmer dude, Galik, genpfault, user6910411

If this question can be reworded to fit the rules in the help center, please edit the question.

closed as off-topic by Some programmer dude, Galik, genpfault, SRack, user6910411 Nov 8 at 20:52

This question appears to be off-topic. The users who voted to close gave this specific reason:

"Questions asking us to recommend or find a book, tool, software library, tutorial or other off-site resource are off-topic for Stack Overflow as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it." – Some programmer dude, Galik, genpfault, user6910411

If this question can be reworded to fit the rules in the help center, please edit the question.

2

"I don't want to run some code documentation tool and generate bunch of html pages" - Other than "code documentation tools" I can't think of anything that would document your code for you tbh. The output of such tools is likely easy(ish) to parse and tabulate.
– Galik
Nov 8 at 15:15

@Galik okay, we can go code-doc tool route too, no problem. I just wanted something with less noise and precise. I want to ignore as much as possible and just focus on these private variables.
– ticktock
Nov 8 at 15:19

1

Aparently Doxygen has an XML output format that may be easier to parse: doxygen.org/manual/output.html
– Galik
Nov 8 at 15:20

1

Also you could maybe use clang to dump out the AST and parse that. stackoverflow.com/questions/18560019/how-to-view-clang-ast
– Galik
Nov 8 at 15:26

1

With doxygen don't forget to set EXTRACT_PRIVATE, also look at the WARN... settings.
– albert
Nov 8 at 16:18

add a comment |

2

"I don't want to run some code documentation tool and generate bunch of html pages" - Other than "code documentation tools" I can't think of anything that would document your code for you tbh. The output of such tools is likely easy(ish) to parse and tabulate.
– Galik
Nov 8 at 15:15

@Galik okay, we can go code-doc tool route too, no problem. I just wanted something with less noise and precise. I want to ignore as much as possible and just focus on these private variables.
– ticktock
Nov 8 at 15:19

1

Aparently Doxygen has an XML output format that may be easier to parse: doxygen.org/manual/output.html
– Galik
Nov 8 at 15:20

1

Also you could maybe use clang to dump out the AST and parse that. stackoverflow.com/questions/18560019/how-to-view-clang-ast
– Galik
Nov 8 at 15:26

1

With doxygen don't forget to set EXTRACT_PRIVATE, also look at the WARN... settings.
– albert
Nov 8 at 16:18

"I don't want to run some code documentation tool and generate bunch of html pages" - Other than "code documentation tools" I can't think of anything that would document your code for you tbh. The output of such tools is likely easy(ish) to parse and tabulate.
– Galik
Nov 8 at 15:15

@Galik okay, we can go code-doc tool route too, no problem. I just wanted something with less noise and precise. I want to ignore as much as possible and just focus on these private variables.
– ticktock
Nov 8 at 15:19

Aparently Doxygen has an XML output format that may be easier to parse: doxygen.org/manual/output.html
– Galik
Nov 8 at 15:20

Also you could maybe use clang to dump out the AST and parse that. stackoverflow.com/questions/18560019/how-to-view-clang-ast
– Galik
Nov 8 at 15:26

With doxygen don't forget to set EXTRACT_PRIVATE, also look at the WARN... settings.
– albert
Nov 8 at 16:18

add a comment |

active

oldest

votes

This page is only for reference, If you need detailed information, please check here

搜尋此網誌

Dfyjkt