Bug 305576

Summary: C preprocessor support is not documented in user's manuals
Product: [Tools] PTP Reporter: Jeffrey Overbey <com-eclipse-dot-org>
Component: Photran.DocumentationAssignee: Jeffrey Overbey <com-eclipse-dot-org>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: P1    
Version: 6.0   
Target Milestone: 6.0   
Hardware: PC   
OS: Mac OS X - Carbon (unsup.)   
Whiteboard:
Bug Depends on: 286446, 290209    
Bug Blocks:    

Description Jeffrey Overbey CLA 2010-03-11 14:20:00 EST 
C preprocessor support needs to be described in...

Photran 6 User's Guide
http://wiki.eclipse.org/PTP/photran/documentation/photran6

Photran 6 Advanced Features
http://wiki.eclipse.org/PTP/photran/documentation/photran6advanced

Topics in the (basic) User's Guide should include:
(1) what the C preprocessor allows (#include, #define, #ifdef, __LINE__, __FILE__etc.)
(2) how Photran decides what files are C preprocessed (content types/filename extensions) and how to change this
(3) how to set C preprocessor include paths
(4) how to set predefined macros

The Advanced Features manual should note which features do not (yet) work on C preprocessed code (refactorings) and which ones do (the others).
Comment 1 Jeffrey Overbey CLA 2010-03-12 16:31:20 EST 
Fixed